Jazz2::Scripting namespace

Scripting-related classes, compiled only if WITH_ANGELSCRIPT.

Namespaces

namespace Legacy
Legacy JJ2+ definitions.

Classes

class CScriptArray
AngelScript array
class CScriptDictionary
AngelScript dictionary
class CScriptDictValue
AngelScript dictionary value
class CScriptHandle
AngelScript reference handle
class LevelScriptLoader
Binds an AngelScript script file to LevelHandler and executes the script.
class ScriptActorWrapper
Wraps a scripted actor, forwarding engine callbacks to the AngelScript object.
class ScriptCollectibleWrapper
Wraps a scripted collectible actor, forwarding engine callbacks to the AngelScript object.
class ScriptLoader
Generic AngelScript script loader with #include and #pragma directive support.
class ScriptPlayerWrapper
Wraps a player actor for access from AngelScript.

Enums

enum class DrawType { WeaponAmmo, Health, Lives, PlayerTimer, Score, GameModeHUD }
Specifies a part to be drawn in LevelScriptLoader::OnDraw().
enum class ScriptContextType { Unknown, AlreadyIncluded, Legacy, Standard }
Script context type.
enum class ScriptBuildResult { Success = asSUCCESS, InvalidConfiguration = asINVALID_CONFIGURATION, BuildFailed = asERROR, BuildInProgress = asBUILD_IN_PROGRESS, InitGlobalVarsFailed = asINIT_GLOBAL_VARS_FAILED, NotSupported = asNOT_SUPPORTED, ModuleIsInUse = asMODULE_IS_IN_USE }
Result of ScriptLoader::Build().

Typedefs

using dictKey_t = String
using dictMap_t = HashMap<dictKey_t, CScriptDictValue>

Functions

auto get_jjObjects(std::int32_t index) -> jjOBJ*
Returns the level object at the given index.
auto get_jjObjectPresets(std::int8_t id) -> jjOBJ*
Returns the object preset for the given event id.
void jjAddParticleTileExplosion(std::uint16_t xTile, std::uint16_t yTile, std::uint16_t tile, bool collapseSceneryStyle)
Spawns a tile-explosion particle effect at the given tile.
void jjAddParticlePixelExplosion(float xPixel, float yPixel, int curFrame, int direction, int mode)
Spawns a pixel-explosion particle effect at the given position.
auto GetParticle(std::int32_t index) -> jjPARTICLE*
Returns the particle at the given index.
auto AddParticle(std::int32_t particleType) -> jjPARTICLE*
Spawns and returns a new particle of the given type.
auto get_jjPlayerCount() -> std::int32_t
Returns the total number of players.
auto get_jjLocalPlayerCount() -> std::int32_t
Returns the number of local players.
auto get_jjP() -> jjPLAYER*
Returns the primary local player.
auto get_jjPlayers(std::uint8_t index) -> jjPLAYER*
Returns the player at the given index.
auto get_jjLocalPlayers(std::uint8_t index) -> jjPLAYER*
Returns the local player at the given index.
auto mlleSetup() -> bool
Runs MLLE (level editor) level setup.
void mlleReapplyPalette()
Reapplies the MLLE-defined palette.
void mlleSpawnOffgrids()
Spawns MLLE off-grid objects.
void mlleSpawnOffgridsLocal()
Spawns MLLE off-grid objects for the local player.
auto get_sinTable(std::uint32_t angle) -> float
Returns the sine of the given table angle.
auto get_cosTable(std::uint32_t angle) -> float
Returns the cosine of the given table angle.
auto RandWord32() -> std::uint32_t
Returns a random 32-bit word.
auto unixTimeSec() -> std::uint64_t
Returns the current Unix time in seconds.
auto unixTimeMs() -> std::uint64_t
Returns the current Unix time in milliseconds.
auto jjRegexIsValid(const String& expression) -> bool
Returns whether the given regular expression is valid.
auto jjRegexMatch(const String& text, const String& expression, bool ignoreCase) -> bool
Returns whether the text fully matches the regular expression.
auto jjRegexMatchWithResults(const String& text, const String& expression, CScriptArray& results, bool ignoreCase) -> bool
Returns whether the text fully matches the regular expression, outputting captured groups.
auto jjRegexSearch(const String& text, const String& expression, bool ignoreCase) -> bool
Returns whether the regular expression is found anywhere in the text.
auto jjRegexSearchWithResults(const String& text, const String& expression, CScriptArray& results, bool ignoreCase) -> bool
Returns whether the regular expression is found anywhere in the text, outputting captured groups.
auto jjRegexReplace(const String& text, const String& expression, const String& replacement, bool ignoreCase) -> String
Returns the text with regular expression matches replaced.
auto GetFPS() -> std::int32_t
Returns the current frames per second.
auto isAdmin() -> bool
Returns whether the local player is a server administrator.
auto getLevelFileName() -> String
Returns the file name of the current level.
auto getCurrLevelName() -> String
Returns the display name of the current level.
void setCurrLevelName(const String& in)
Sets the display name of the current level.
auto get_jjTilesetFileName() -> String
Returns the file name of the current tileset.
auto get_gameState() -> std::int32_t
Returns the current game state.
auto getBorderWidth() -> std::int32_t
auto getBorderHeight() -> std::int32_t
Returns the height of the screen border.
auto getSplitscreenType() -> bool
Returns whether split-screen is forced.
auto setSplitscreenType(bool value) -> bool
Sets whether split-screen is forced.
auto get_teamScore(std::int32_t color) -> std::int32_t
auto GetMaxHealth() -> std::int32_t
Returns the maximum player health.
auto GetStartHealth() -> std::int32_t
Returns the starting player health.
void jjSetDarknessColor(jjPALCOLOR color)
void jjSetFadeColors(std::uint8_t red, std::uint8_t green, std::uint8_t blue)
Sets the fade color from red, green and blue components.
void jjSetFadeColorsFromPalette(std::uint8_t paletteColorID)
Sets the fade color from a palette index.
void jjSetFadeColorsFromPalcolor(jjPALCOLOR color)
Sets the fade color from a palette color.
auto jjGetFadeColors() -> jjPALCOLOR
Returns the current fade color.
void jjUpdateTexturedBG()
Recomputes the textured background.
auto get_jjTexturedBGTexture() -> std::int32_t
Returns the texture used by the textured background.
auto set_jjTexturedBGTexture(std::int32_t texture) -> std::int32_t
Sets the texture used by the textured background.
auto get_jjTexturedBGStyle() -> std::int32_t
Returns the textured background style.
auto set_jjTexturedBGStyle(std::int32_t style) -> std::int32_t
Sets the textured background style.
auto get_jjTexturedBGUsed() -> bool
Returns whether the textured background is used.
auto set_jjTexturedBGUsed(bool used) -> bool
Sets whether the textured background is used.
auto get_jjTexturedBGStars() -> bool
Returns whether stars are drawn in the textured background.
auto set_jjTexturedBGStars(bool used) -> bool
Sets whether stars are drawn in the textured background.
auto get_jjTexturedBGFadePositionX() -> float
Returns the horizontal fade position of the textured background.
auto set_jjTexturedBGFadePositionX(float value) -> float
Sets the horizontal fade position of the textured background.
auto get_jjTexturedBGFadePositionY() -> float
Returns the vertical fade position of the textured background.
auto set_jjTexturedBGFadePositionY(float value) -> float
Sets the vertical fade position of the textured background.
auto getEnabledTeam(std::uint8_t team) -> bool
Returns whether the given team is enabled.
auto getKeyDown(std::uint8_t key) -> bool
Returns whether the given key is currently held down.
auto getCursorX() -> std::int32_t
Returns the cursor's horizontal position.
auto getCursorY() -> std::int32_t
Returns the cursor's vertical position.
void playSample(float xPixel, float yPixel, std::int32_t sample, std::int32_t volume, std::int32_t frequency)
Plays a sound sample at the given position.
auto playLoopedSample(float xPixel, float yPixel, std::int32_t sample, std::int32_t channel, std::int32_t volume, std::int32_t frequency) -> std::int32_t
Plays a looped sound sample on a channel and returns the channel.
void playPrioritySample(std::int32_t sample)
Plays a sound sample with priority, ignoring position.
auto isSampleLoaded(std::int32_t sample) -> bool
Returns whether the given sample is loaded.
auto loadSample(std::int32_t sample, const String& filename) -> bool
Loads a sound sample from a file.
auto getUseLayer8Speeds() -> bool
Returns whether layer 8 uses its own scrolling speeds.
auto setUseLayer8Speeds(bool value) -> bool
Sets whether layer 8 uses its own scrolling speeds.
auto get_jjWEAPON(int index) -> jjWEAPON*
Returns the weapon settings at the given index.
auto get_jjCHARACTER(int index) -> jjCHARACTER*
Returns the character settings at the given index.
auto GetEvent(std::uint16_t tx, std::uint16_t ty) -> std::int32_t
Returns the event id at the given tile coordinates.
auto GetEventParamWrapper(std::uint16_t tx, std::uint16_t ty, std::int32_t offset, std::int32_t length) -> std::int32_t
Returns a field of the event at the given tile coordinates.
void SetEventByte(std::uint16_t tx, std::uint16_t ty, std::uint8_t newEventId)
Sets the event id at the given tile coordinates.
void SetEventParam(std::uint16_t tx, std::uint16_t ty, int8_t offset, std::int8_t length, std::int32_t newValue)
Sets a field of the event at the given tile coordinates.
auto GetTileType(std::uint16_t tile) -> std::int8_t
Returns the collision type of the given tile.
auto SetTileType(std::uint16_t tile, std::uint16_t value) -> std::int8_t
Sets the collision type of the given tile.
auto jjGetStaticTile(std::uint16_t tileID) -> std::uint16_t
auto jjTileGet(std::uint8_t layer, std::int32_t xTile, std::int32_t yTile) -> std::uint16_t
Returns the tile at the given coordinates on the given layer.
auto jjTileSet(std::uint8_t layer, std::int32_t xTile, std::int32_t yTile, std::uint16_t newTile) -> std::uint16_t
Sets the tile at the given coordinates on the given layer.
void jjGenerateSettableTileArea(std::uint8_t layer, std::int32_t xTile, std::int32_t yTile, std::int32_t width, std::int32_t height)
Marks a rectangular tile area on the given layer as runtime-settable.
auto jjMaskedPixel(std::int32_t xPixel, std::int32_t yPixel) -> bool
auto jjMaskedPixelLayer(std::int32_t xPixel, std::int32_t yPixel, std::uint8_t layer) -> bool
Returns whether the given pixel is masked (solid) on the given layer.
auto jjMaskedHLine(std::int32_t xPixel, std::int32_t lineLength, std::int32_t yPixel) -> bool
Returns whether any pixel along the horizontal line is masked (solid).
auto jjMaskedHLineLayer(std::int32_t xPixel, std::int32_t lineLength, std::int32_t yPixel, std::uint8_t layer) -> bool
Returns whether any pixel along the horizontal line is masked (solid) on the given layer.
auto jjMaskedVLine(std::int32_t xPixel, std::int32_t yPixel, std::int32_t lineLength) -> bool
Returns whether any pixel along the vertical line is masked (solid).
auto jjMaskedVLineLayer(std::int32_t xPixel, std::int32_t yPixel, std::int32_t lineLength, std::uint8_t layer) -> bool
Returns whether any pixel along the vertical line is masked (solid) on the given layer.
auto jjMaskedTopVLine(std::int32_t xPixel, std::int32_t yPixel, std::int32_t lineLength) -> bool
Returns whether the topmost pixel along the vertical line is masked (solid).
auto jjMaskedTopVLineLayer(std::int32_t xPixel, std::int32_t yPixel, std::int32_t lineLength, std::uint8_t layer) -> bool
Returns whether the topmost pixel along the vertical line is masked (solid) on the given layer.
void jjSetModPosition(std::int32_t order, std::int32_t row, bool reset)
void jjSlideModChannelVolume(std::int32_t channel, float volume, std::int32_t milliseconds)
Slides a music channel's volume to the given level over time.
auto jjGetModOrder() -> std::int32_t
Returns the current music order.
auto jjGetModRow() -> std::int32_t
Returns the current music row.
auto jjGetModTempo() -> std::int32_t
Returns the current music tempo.
void jjSetModTempo(std::uint8_t speed)
Sets the music tempo.
auto jjGetModSpeed() -> std::int32_t
Returns the current music speed.
void jjSetModSpeed(std::uint8_t speed)
Sets the music speed.
auto getCustomSetID(std::uint8_t index) -> std::uint32_t
Returns the custom animation set id at the given index.
void RegisterArray(asIScriptEngine* engine)
Registers array type to AngelScript engine.
void RegisterDictionary(asIScriptEngine* engine)
Registers dictionary type to AngelScript engine.
void RegisterImGuiBindings(asIScriptEngine* engine)
Registers ImGui bindings to AngelScript engine.
void RegisterMath(asIScriptEngine* engine)
Registers vec2/vec3/vec4/vec2i/vec3i/vec4i/Color types to AngelScript engine.
void RegisterRef(asIScriptEngine* engine)
Registers ref type to AngelScript engine.
void RegisterString(asIScriptEngine* engine)
Registers Death::Containers::String as string type to AngelScript engine.
void RegisterArray(asIScriptEngine* engine)
Registers array type to AngelScript engine.
void RegisterDictionary(asIScriptEngine* engine)
Registers dictionary type to AngelScript engine.
void RegisterRef(asIScriptEngine* engine)
Registers ref type to AngelScript engine.

Enum documentation

enum class Jazz2::Scripting::DrawType
#include <Jazz2/Scripting/LevelScriptLoader.h>

Specifies a part to be drawn in LevelScriptLoader::OnDraw().

Identifies an individual HUD element a script may override or augment while drawing, such as the weapon ammo, health, lives, player timer, score or the game mode specific overlay. It is passed to the draw callback so the script can render or customize that particular part.

enum class Jazz2::Scripting::ScriptContextType
#include <Jazz2/Scripting/ScriptLoader.h>

Script context type.

Identifies the dialect of a loaded script part as it is processed, distinguishing legacy JJ2+ compatible scripts from standard Jazz² Resurrection scripts, as well as parts that are unsupported or were already included. It is reported per file and may be refined by #pragma directives.

Enumerators
Unknown

Unknown/unsupported script part.
AlreadyIncluded

Already included script part.
Legacy

Legacy (JJ2+ compatible) script part.
Standard

Standard (Jazz² Resurrection compatible) script part.

enum class Jazz2::Scripting::ScriptBuildResult
#include <Jazz2/Scripting/ScriptLoader.h>

Result of ScriptLoader::Build().

Reports the outcome of compiling the main script module, mirroring the underlying AngelScript return codes for success and the various failure conditions such as an invalid engine configuration, a failed build, a build already in progress or missing compiler support.

Enumerators
Success

The engine succeeded.
InvalidConfiguration

The engine configuration is invalid.
BuildFailed

The script failed to build.
BuildInProgress

Another thread is currently building.
InitGlobalVarsFailed

It was not possible to initialize at least one of the global variables.
NotSupported

Compiler support is disabled in the engine.
ModuleIsInUse

The code in the module is still being used and and cannot be removed.

Typedef documentation

typedef String Jazz2::Scripting::dictKey_t
#include <Jazz2/Scripting/RegisterDictionary.h>

typedef HashMap<dictKey_t, CScriptDictValue> Jazz2::Scripting::dictMap_t
#include <Jazz2/Scripting/RegisterDictionary.h>

Function documentation

jjOBJ* Jazz2::Scripting::get_jjObjects(std::int32_t index)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the level object at the given index.

jjOBJ* Jazz2::Scripting::get_jjObjectPresets(std::int8_t id)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the object preset for the given event id.

void Jazz2::Scripting::jjAddParticleTileExplosion(std::uint16_t xTile, std::uint16_t yTile, std::uint16_t tile, bool collapseSceneryStyle)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Spawns a tile-explosion particle effect at the given tile.

void Jazz2::Scripting::jjAddParticlePixelExplosion(float xPixel, float yPixel, int curFrame, int direction, int mode)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Spawns a pixel-explosion particle effect at the given position.

jjPARTICLE* Jazz2::Scripting::GetParticle(std::int32_t index)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the particle at the given index.

jjPARTICLE* Jazz2::Scripting::AddParticle(std::int32_t particleType)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Spawns and returns a new particle of the given type.

std::int32_t Jazz2::Scripting::get_jjPlayerCount()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the total number of players.

std::int32_t Jazz2::Scripting::get_jjLocalPlayerCount()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the number of local players.

jjPLAYER* Jazz2::Scripting::get_jjP()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the primary local player.

jjPLAYER* Jazz2::Scripting::get_jjPlayers(std::uint8_t index)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the player at the given index.

jjPLAYER* Jazz2::Scripting::get_jjLocalPlayers(std::uint8_t index)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the local player at the given index.

bool Jazz2::Scripting::mlleSetup()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Runs MLLE (level editor) level setup.

void Jazz2::Scripting::mlleReapplyPalette()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Reapplies the MLLE-defined palette.

void Jazz2::Scripting::mlleSpawnOffgrids()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Spawns MLLE off-grid objects.

void Jazz2::Scripting::mlleSpawnOffgridsLocal()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Spawns MLLE off-grid objects for the local player.

float Jazz2::Scripting::get_sinTable(std::uint32_t angle)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the sine of the given table angle.

float Jazz2::Scripting::get_cosTable(std::uint32_t angle)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the cosine of the given table angle.

std::uint32_t Jazz2::Scripting::RandWord32()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns a random 32-bit word.

std::uint64_t Jazz2::Scripting::unixTimeSec()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the current Unix time in seconds.

std::uint64_t Jazz2::Scripting::unixTimeMs()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the current Unix time in milliseconds.

bool Jazz2::Scripting::jjRegexIsValid(const String& expression)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the given regular expression is valid.

bool Jazz2::Scripting::jjRegexMatch(const String& text, const String& expression, bool ignoreCase)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the text fully matches the regular expression.

bool Jazz2::Scripting::jjRegexMatchWithResults(const String& text, const String& expression, CScriptArray& results, bool ignoreCase)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the text fully matches the regular expression, outputting captured groups.

bool Jazz2::Scripting::jjRegexSearch(const String& text, const String& expression, bool ignoreCase)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the regular expression is found anywhere in the text.

bool Jazz2::Scripting::jjRegexSearchWithResults(const String& text, const String& expression, CScriptArray& results, bool ignoreCase)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the regular expression is found anywhere in the text, outputting captured groups.

String Jazz2::Scripting::jjRegexReplace(const String& text, const String& expression, const String& replacement, bool ignoreCase)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the text with regular expression matches replaced.

std::int32_t Jazz2::Scripting::GetFPS()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the current frames per second.

bool Jazz2::Scripting::isAdmin()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the local player is a server administrator.

String Jazz2::Scripting::getLevelFileName()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the file name of the current level.

String Jazz2::Scripting::getCurrLevelName()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the display name of the current level.

void Jazz2::Scripting::setCurrLevelName(const String& in)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the display name of the current level.

String Jazz2::Scripting::get_jjTilesetFileName()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the file name of the current tileset.

std::int32_t Jazz2::Scripting::get_gameState()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the current game state.

std::int32_t Jazz2::Scripting::getBorderHeight()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the height of the screen border.

bool Jazz2::Scripting::getSplitscreenType()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether split-screen is forced.

bool Jazz2::Scripting::setSplitscreenType(bool value)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets whether split-screen is forced.

std::int32_t Jazz2::Scripting::GetMaxHealth()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the maximum player health.

std::int32_t Jazz2::Scripting::GetStartHealth()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the starting player health.

void Jazz2::Scripting::jjSetFadeColors(std::uint8_t red, std::uint8_t green, std::uint8_t blue)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the fade color from red, green and blue components.

void Jazz2::Scripting::jjSetFadeColorsFromPalette(std::uint8_t paletteColorID)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the fade color from a palette index.

void Jazz2::Scripting::jjSetFadeColorsFromPalcolor(jjPALCOLOR color)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the fade color from a palette color.

jjPALCOLOR Jazz2::Scripting::jjGetFadeColors()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the current fade color.

void Jazz2::Scripting::jjUpdateTexturedBG()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Recomputes the textured background.

std::int32_t Jazz2::Scripting::get_jjTexturedBGTexture()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the texture used by the textured background.

std::int32_t Jazz2::Scripting::set_jjTexturedBGTexture(std::int32_t texture)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the texture used by the textured background.

std::int32_t Jazz2::Scripting::get_jjTexturedBGStyle()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the textured background style.

std::int32_t Jazz2::Scripting::set_jjTexturedBGStyle(std::int32_t style)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the textured background style.

bool Jazz2::Scripting::get_jjTexturedBGUsed()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the textured background is used.

bool Jazz2::Scripting::set_jjTexturedBGUsed(bool used)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets whether the textured background is used.

bool Jazz2::Scripting::get_jjTexturedBGStars()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether stars are drawn in the textured background.

bool Jazz2::Scripting::set_jjTexturedBGStars(bool used)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets whether stars are drawn in the textured background.

float Jazz2::Scripting::get_jjTexturedBGFadePositionX()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the horizontal fade position of the textured background.

float Jazz2::Scripting::set_jjTexturedBGFadePositionX(float value)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the horizontal fade position of the textured background.

float Jazz2::Scripting::get_jjTexturedBGFadePositionY()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the vertical fade position of the textured background.

float Jazz2::Scripting::set_jjTexturedBGFadePositionY(float value)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the vertical fade position of the textured background.

bool Jazz2::Scripting::getEnabledTeam(std::uint8_t team)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the given team is enabled.

bool Jazz2::Scripting::getKeyDown(std::uint8_t key)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the given key is currently held down.

std::int32_t Jazz2::Scripting::getCursorX()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the cursor's horizontal position.

std::int32_t Jazz2::Scripting::getCursorY()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the cursor's vertical position.

void Jazz2::Scripting::playSample(float xPixel, float yPixel, std::int32_t sample, std::int32_t volume, std::int32_t frequency)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Plays a sound sample at the given position.

std::int32_t Jazz2::Scripting::playLoopedSample(float xPixel, float yPixel, std::int32_t sample, std::int32_t channel, std::int32_t volume, std::int32_t frequency)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Plays a looped sound sample on a channel and returns the channel.

void Jazz2::Scripting::playPrioritySample(std::int32_t sample)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Plays a sound sample with priority, ignoring position.

bool Jazz2::Scripting::isSampleLoaded(std::int32_t sample)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the given sample is loaded.

bool Jazz2::Scripting::loadSample(std::int32_t sample, const String& filename)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Loads a sound sample from a file.

bool Jazz2::Scripting::getUseLayer8Speeds()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether layer 8 uses its own scrolling speeds.

bool Jazz2::Scripting::setUseLayer8Speeds(bool value)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets whether layer 8 uses its own scrolling speeds.

jjWEAPON* Jazz2::Scripting::get_jjWEAPON(int index)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the weapon settings at the given index.

jjCHARACTER* Jazz2::Scripting::get_jjCHARACTER(int index)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the character settings at the given index.

std::int32_t Jazz2::Scripting::GetEvent(std::uint16_t tx, std::uint16_t ty)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the event id at the given tile coordinates.

std::int32_t Jazz2::Scripting::GetEventParamWrapper(std::uint16_t tx, std::uint16_t ty, std::int32_t offset, std::int32_t length)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns a field of the event at the given tile coordinates.

void Jazz2::Scripting::SetEventByte(std::uint16_t tx, std::uint16_t ty, std::uint8_t newEventId)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the event id at the given tile coordinates.

void Jazz2::Scripting::SetEventParam(std::uint16_t tx, std::uint16_t ty, int8_t offset, std::int8_t length, std::int32_t newValue)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets a field of the event at the given tile coordinates.

std::int8_t Jazz2::Scripting::GetTileType(std::uint16_t tile)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the collision type of the given tile.

std::int8_t Jazz2::Scripting::SetTileType(std::uint16_t tile, std::uint16_t value)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the collision type of the given tile.

std::uint16_t Jazz2::Scripting::jjTileGet(std::uint8_t layer, std::int32_t xTile, std::int32_t yTile)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the tile at the given coordinates on the given layer.

std::uint16_t Jazz2::Scripting::jjTileSet(std::uint8_t layer, std::int32_t xTile, std::int32_t yTile, std::uint16_t newTile)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the tile at the given coordinates on the given layer.

void Jazz2::Scripting::jjGenerateSettableTileArea(std::uint8_t layer, std::int32_t xTile, std::int32_t yTile, std::int32_t width, std::int32_t height)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Marks a rectangular tile area on the given layer as runtime-settable.

bool Jazz2::Scripting::jjMaskedPixel(std::int32_t xPixel, std::int32_t yPixel)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

bool Jazz2::Scripting::jjMaskedPixelLayer(std::int32_t xPixel, std::int32_t yPixel, std::uint8_t layer)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the given pixel is masked (solid) on the given layer.

bool Jazz2::Scripting::jjMaskedHLine(std::int32_t xPixel, std::int32_t lineLength, std::int32_t yPixel)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether any pixel along the horizontal line is masked (solid).

bool Jazz2::Scripting::jjMaskedHLineLayer(std::int32_t xPixel, std::int32_t lineLength, std::int32_t yPixel, std::uint8_t layer)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether any pixel along the horizontal line is masked (solid) on the given layer.

bool Jazz2::Scripting::jjMaskedVLine(std::int32_t xPixel, std::int32_t yPixel, std::int32_t lineLength)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether any pixel along the vertical line is masked (solid).

bool Jazz2::Scripting::jjMaskedVLineLayer(std::int32_t xPixel, std::int32_t yPixel, std::int32_t lineLength, std::uint8_t layer)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether any pixel along the vertical line is masked (solid) on the given layer.

bool Jazz2::Scripting::jjMaskedTopVLine(std::int32_t xPixel, std::int32_t yPixel, std::int32_t lineLength)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the topmost pixel along the vertical line is masked (solid).

bool Jazz2::Scripting::jjMaskedTopVLineLayer(std::int32_t xPixel, std::int32_t yPixel, std::int32_t lineLength, std::uint8_t layer)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns whether the topmost pixel along the vertical line is masked (solid) on the given layer.

void Jazz2::Scripting::jjSetModPosition(std::int32_t order, std::int32_t row, bool reset)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

void Jazz2::Scripting::jjSlideModChannelVolume(std::int32_t channel, float volume, std::int32_t milliseconds)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Slides a music channel's volume to the given level over time.

std::int32_t Jazz2::Scripting::jjGetModOrder()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the current music order.

std::int32_t Jazz2::Scripting::jjGetModRow()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the current music row.

std::int32_t Jazz2::Scripting::jjGetModTempo()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the current music tempo.

void Jazz2::Scripting::jjSetModTempo(std::uint8_t speed)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the music tempo.

std::int32_t Jazz2::Scripting::jjGetModSpeed()
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the current music speed.

void Jazz2::Scripting::jjSetModSpeed(std::uint8_t speed)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Sets the music speed.

std::uint32_t Jazz2::Scripting::getCustomSetID(std::uint8_t index)
#include <Jazz2/Scripting/JJ2PlusDefinitions.h>

Returns the custom animation set id at the given index.

void Jazz2::Scripting::RegisterArray(asIScriptEngine* engine)
#include <Jazz2/Scripting/RegisterArray.h>

Registers array type to AngelScript engine.

void Jazz2::Scripting::RegisterDictionary(asIScriptEngine* engine)
#include <Jazz2/Scripting/RegisterDictionary.h>

Registers dictionary type to AngelScript engine.

void Jazz2::Scripting::RegisterImGuiBindings(asIScriptEngine* engine)
#include <Jazz2/Scripting/RegisterImGuiBindings.h>

Registers ImGui bindings to AngelScript engine.

void Jazz2::Scripting::RegisterMath(asIScriptEngine* engine)
#include <Jazz2/Scripting/RegisterMath.h>

Registers vec2/vec3/vec4/vec2i/vec3i/vec4i/Color types to AngelScript engine.

void Jazz2::Scripting::RegisterRef(asIScriptEngine* engine)
#include <Jazz2/Scripting/RegisterRef.h>

Registers ref type to AngelScript engine.

void Jazz2::Scripting::RegisterString(asIScriptEngine* engine)
#include <Jazz2/Scripting/RegisterString.h>

Registers Death::Containers::String as string type to AngelScript engine.