Jazz2::Scripting namespace

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

Typedef documentation

Function documentation