List of partially supported features

auto Jazz2::Scripting::get_jjPlayerCount() -> std::int32_t
A client of a multiplayer game counts only its own players, the players of the other machines aren't in its level.
void Jazz2::Scripting::SetEventByte(std::uint16_t tx, std::uint16_t ty, std::uint8_t newEventId)
A generator event (an object that respawns) can't be written, it's refused with a warning.
class Jazz2::Scripting::Legacy::jjPLAYER
A handle that doesn't stand for a player in the level has isActive set to false, most of its properties read as 0 and writes to them are ignored.
auto Jazz2::Scripting::Legacy::jjLAYER::jjLayerOrderSet(const CScriptArray& order) -> bool
A layer that couldn't be added to the level (see CreateFromSize()) is left out without an error.
std::int32_t Jazz2::Scripting::Legacy::jjPLAYER::specialMove
A non-zero value identifies the move rather than how long it has lasted.
auto Jazz2::Scripting::getBorderHeight() -> std::int32_t
auto Jazz2::Scripting::getBorderWidth() -> std::int32_t
Always returns 0, there are no such borders.
void Jazz2::Scripting::Legacy::jjOBJ::behave1(std::uint32_t behavior, bool draw)
An object a script made runs only the bullet behaviors, CRATE, EXPLOSION, SHARD, WALKINGENEMY, BOUNCEONCE, FLICKERGEM, PICKUP, BUBBLE, UTERUSSPIKEBALL and INACTIVE (the five before INACTIVE aren't measured in JJ2+), any other only moves it by its speeds. An object of the game runs its own update for most behaviors. Seeker bullets don't home and RF bullets fly straight.
class Death::IO::FileSystem::MapDeleter
auto Death::IO::FileSystem::OpenAsMemoryMapped(Containers::StringView path, FileAccess mode) -> std::optional<Containers::Array<char, MapDeleter>>
Available on all platforms except Emscripten, Nintendo Switch and Windows RT.
class Death::IO::AndroidAssetStream
auto Death::IO::FileSystem::GetExternalStorage() -> Containers::String
bool Jazz2::PreferencesCache::UseNativeBackButton
Available only on Android platform.
auto Death::Environment::GetAppleDeviceModel() -> Containers::String
auto Death::Environment::GetAppleVersion() -> Containers::String
Available only on Apple platforms.
void Jazz2::PreferencesCache::DescribeNextMemoryCardFile(StringView shortDescription, StringView longDescription)
Available only on Dreamcast and GameCube platforms.
auto Death::Environment::IsEmbedded() noexcept -> bool
class Death::IO::EmscriptenFilePicker
class Death::IO::EmscriptenFileStream
auto Death::IO::FileSystem::MountAsPersistent(Containers::StringView path) -> bool
void Death::IO::FileSystem::SyncToPersistent()
bool Jazz2::PreferencesCache::IsStandalone
Available only on Emscripten platform.
auto Death::Environment::GetSwitchVersion() -> std::uint32_t
auto Death::Environment::HasSwitchAtmosphere() -> bool
Available only on Nintendo Switch platform.
auto Jazz2::Multiplayer::NetworkManagerBase::SetAdhocMode(bool enabled) -> bool
bool Jazz2::Multiplayer::ServerConfiguration::AdhocMode
void Jazz2::UI::Menu::ServerSelectSection::ToggleAdhocMode()
Available only on PlayStation Portable platform.
auto Death::Environment::GetUnixFlavor() -> Containers::String
auto Death::IO::FileSystem::GetLocalStorage() -> Containers::String
Available only on Unix platform.
Containers::String Death::Backward::ExceptionHandling::DumpDirectory
auto Death::Containers::ComPtr<T>::as(U** result) const noexcept -> HRESULT
Death::Containers::ComPtr<T>::ComPtr(U* ptr) noexcept
Death::Containers::DateTime::DateTime(const SYSTEMTIME& st) noexcept
Death::Containers::DateTime::DateTime(const FILETIME& st) noexcept
auto Death::Containers::DateTime::ToWin32() const noexcept -> SYSTEMTIME
auto Death::Environment::IsWindows7() noexcept -> bool
auto Death::Environment::IsWindows8() noexcept -> bool
auto Death::Environment::IsWindows10() noexcept -> bool
auto Death::Environment::IsWindows11() noexcept -> bool
auto Death::Environment::IsWindowsVista() noexcept -> bool
auto Death::Environment::IsWine() noexcept -> bool
auto Death::IO::FileSystem::GetWindowsDirectory() -> Containers::String
const std::uint64_t Death::Environment::WindowsVersion
Available only on Windows platform.
const DeviceType Death::Environment::CurrentDeviceType
Available only on Windows RT platform.
auto Death::Utf8::FromUtf16(const wchar_t* source, std::int32_t sourceSize) -> Containers::String
auto Death::Utf8::ToUtf16(const char* source, std::int32_t sourceSize) -> Containers::Array<wchar_t>
Available only on Windows to be used when dealing directly with Windows Unicode APIs.
std::int32_t Jazz2::Scripting::Legacy::jjPLAYER::helicopterElapsed
Currently always 0 and has no effect.
std::int32_t Jazz2::Scripting::Legacy::jjPLAYER::flag
Currently always 0.
auto Jazz2::Scripting::Legacy::jjANIMATION::load(const String& filename, std::int32_t hotSpotX, std::int32_t hotSpotY, std::int32_t coldSpotYOffset, std::int32_t firstFrameToOverwrite) -> bool
auto Jazz2::Scripting::Legacy::jjANIMATION::save(const String& filename, const jjPAL& palette) const -> bool
Currently has no effect and always returns false.
std::int32_t Jazz2::Scripting::Legacy::jjLAYER::rotationAngle
std::int32_t Jazz2::Scripting::Legacy::jjLAYER::rotationRadiusMultiplier
Currently has no effect, and it starts as 0 on every layer.
void Jazz2::Scripting::Legacy::jjCANVAS::jjDrawString(float xPixel, float yPixel, const String& text, const jjANIMATION& animation, std::uint32_t mode, std::uint8_t param, std::int8_t layerZ, std::uint8_t layerXY, std::int8_t playerID)
void Jazz2::Scripting::Legacy::jjCANVAS::jjDrawStringEx(float xPixel, float yPixel, const String& text, const jjANIMATION& animation, const jjTEXTAPPEARANCE& appearance, std::uint8_t param1, std::uint32_t spriteMode, std::uint8_t param2, std::int8_t layerZ, std::uint8_t layerXY, std::int8_t playerID)
void Jazz2::Scripting::Legacy::jjOBJ::pathMovement()
void Jazz2::Scripting::Legacy::jjPLAYER::poleSpin(float xSpeed, float ySpeed, std::uint32_t delay)
Currently has no effect.
bool Jazz2::Scripting::Legacy::jjPLAYERDRAW::airboardBouncingMotion
bool Jazz2::Scripting::Legacy::jjPLAYERDRAW::airboardPuff
bool Jazz2::Scripting::Legacy::jjPLAYERDRAW::invincibility
bool Jazz2::Scripting::Legacy::jjPLAYERDRAW::morphingExplosions
bool Jazz2::Scripting::Legacy::jjPLAYERDRAW::name
std::int32_t Jazz2::Scripting::Legacy::jjPLAYERDRAW::flag
Currently ignored.
auto Jazz2::Scripting::Legacy::jjCOLORMAP::saveToFile(const String& filename, bool allowCompression) const -> bool
auto Jazz2::Scripting::Legacy::jjPIXELMAP::saveToFile(const String& filename, const jjPAL& palette) const -> bool
Currently not supported, always returns false.
void Jazz2::Scripting::Legacy::jjCANVAS::drawString(std::int32_t xPixel, std::int32_t yPixel, const String& text, const jjANIMATION& animation, std::uint32_t mode, std::uint8_t param)
DARK draws the letters translucent, and the letters of BOUNCE and SPIN don't move.
void Jazz2::Scripting::Legacy::jjPLAYER::showText(const String& text, std::uint32_t size)
void Jazz2::Scripting::Legacy::jjPLAYER::showTextByID(std::uint32_t textID, std::uint32_t offset, std::uint32_t size)
Every player sees the text, not only this one.
auto Jazz2::Scripting::Legacy::jjPLAYER::objectHit(jjOBJ* target, std::int32_t force, std::uint32_t playerHandling) -> bool
force matters to collisions the game handles only as far as the player really attacks.
auto Jazz2::Scripting::jjGetStaticTile(std::uint16_t tileID) -> std::uint16_t
Flips of the frame itself aren't included, and an animated tile whose frame is another animated tile gives 0.
auto Jazz2::Scripting::get_gameState() -> std::int32_t
GAME::PAUSED isn't used.
auto Jazz2::Scripting::Legacy::jjLAYER::CreateFromSize(std::uint32_t width, std::uint32_t height) -> jjLAYER*
If the level can't take another layer, the layer is only a standalone copy of the properties, its tiles can't be set and it's never drawn.
ch_ Jazz2::Scripting::Legacy::jjTEXTAPPEARANCE::at
Ignored for text in a built-in size, and STRING::HIDESIGN starts a new line too.
ch_ Jazz2::Scripting::Legacy::jjTEXTAPPEARANCE::caret
ch_ Jazz2::Scripting::Legacy::jjTEXTAPPEARANCE::hash
ch_ Jazz2::Scripting::Legacy::jjTEXTAPPEARANCE::pipe
ch_ Jazz2::Scripting::Legacy::jjTEXTAPPEARANCE::section
ch_ Jazz2::Scripting::Legacy::jjTEXTAPPEARANCE::tilde
Ignored for text in a built-in size, and STRING::SPECIALSIGN works as STRING::HIDESIGN.
auto Jazz2::Scripting::Legacy::jjPARTICLEPIXEL::get_color(std::int32_t i) const -> std::uint8_t
Indices 0 to 7 are available, reading other ones gives 0 and writing them has no effect, so the last pixel of a 3×3 square can't be reached.
auto Jazz2::Scripting::Legacy::jjPLAYER::get_invincibility() const -> std::int32_t
Invincibility and blink share one timer, starting one ends the other.
void Jazz2::Scripting::jjSlideModChannelVolume(std::int32_t channel, float volume, std::int32_t milliseconds)
It changes the volume of the channel that the module itself can set (with the Mxx effect), so the module may change it again. The change is heard after the audio already prepared, up to about a third of a second.
int Jazz2::Scripting::Legacy::jjCHARACTER::airJump
It has no effect on the frog and the birds.
int Jazz2::Scripting::Legacy::jjCHARACTER::groundJump
It has no effect on the frog and the birds. A move of another character is drawn with the animations of the player's own move, and the kick of Lori keeps the timing of the player's character.
std::int8_t Jazz2::Scripting::Legacy::jjOBJ::noHit
std::uint8_t Jazz2::Scripting::Legacy::jjOBJ::objType
It isn't tied to those properties, writing it has no effect.
auto Jazz2::Scripting::jjMaskedHLineLayer(std::int32_t xPixel, std::int32_t lineLength, std::int32_t yPixel, std::uint8_t layer) -> bool
auto Jazz2::Scripting::jjMaskedPixelLayer(std::int32_t xPixel, std::int32_t yPixel, std::uint8_t layer) -> bool
auto Jazz2::Scripting::jjMaskedTopVLineLayer(std::int32_t xPixel, std::int32_t yPixel, std::int32_t lineLength, std::uint8_t layer) -> std::int32_t
auto Jazz2::Scripting::jjMaskedVLineLayer(std::int32_t xPixel, std::int32_t yPixel, std::int32_t lineLength, std::uint8_t layer) -> bool
layer is ignored, the masks of the sprite layer are tested.
Death::Containers::StaticArray<size_, T>::StaticArray(InPlaceInitT, T(&&data)[size])
Death::Containers::StaticArray<size_, T>::StaticArray(T(&&data)[size])
Not available on MSVC 2015 and MSVC 2017 as these compilers don't support moving arrays.
jjBEHAVIOR Jazz2::Scripting::Legacy::jjOBJ::behavior
Not every built-in behavior is available, see behave1().
auto nCine::AudioStream::GetModuleState(AudioModuleState& state) const -> bool
auto nCine::AudioStreamPlayer::GetModuleState(AudioModuleState& state) const -> bool
Not every decoder supports it, always returns false where NCINE_HAS_NATIVE_AUDIO is defined.
auto nCine::AudioStream::SetModulePosition(std::uint32_t source, std::int32_t order, std::int32_t row, bool restart, bool looping) -> bool
auto nCine::AudioStream::SetModuleSpeed(std::int32_t speed) -> bool
auto nCine::AudioStream::SetModuleTempo(std::int32_t tempo) -> bool
auto nCine::AudioStream::SlideModuleChannelVolume(std::int32_t channel, float volume, std::int32_t milliseconds) -> bool
auto nCine::AudioStreamPlayer::SetModulePosition(std::int32_t order, std::int32_t row) -> bool
auto nCine::AudioStreamPlayer::SetModuleSpeed(std::int32_t speed) -> bool
auto nCine::AudioStreamPlayer::SetModuleTempo(std::int32_t tempo) -> bool
auto nCine::AudioStreamPlayer::SlideModuleChannelVolume(std::int32_t channel, float volume, std::int32_t milliseconds) -> bool
Not every decoder supports it, has no effect where NCINE_HAS_NATIVE_AUDIO is defined.
auto Jazz2::Scripting::Legacy::jjOBJ::draw() -> std::int32_t
On an object of the game it only marks the object to be drawn once in the tick, at its final position, so several calls show only the last frame and a call outside its behavior lasts until the next tick.
std::int8_t Jazz2::Scripting::Legacy::jjOBJ::light
On an object of the game, a new size takes effect only together with another lightType.
void Death::swap(T& a, T& b) noexcept(…)
On MSVC 2015 it's just an alias to std::swap(), as compiler limitations prevent creating an alternative that wouldn't conflict.
void Jazz2::Scripting::Legacy::jjOBJ::blast(std::int32_t maxDistance, bool blastObjects)
Only enemies are hurt by blastObjects, crates and other objects aren't broken.
std::uint16_t Jazz2::Scripting::Legacy::jjOBJ::points
Only enemies of the game award it. A template in jjObjectPresets reads 0 until a script sets it, and setting it back to 0 there keeps the score of the game.
auto Jazz2::Scripting::GetTileType(std::uint16_t tile) -> std::int8_t
Other types are kept as assigned, but such tiles are drawn as ordinary ones.
auto Jazz2::Scripting::Legacy::jjPIXELMAP::CreateFromFrame(const jjANIMFRAME* animFrame, const jjPAL* palette) -> jjPIXELMAP*
palette is ignored, a 32-bit frame gives the indices of its colors in jjPalette as it was when the frame was saved.
void Jazz2::Scripting::Legacy::jjCANVAS::drawStringEx(std::int32_t xPixel, std::int32_t yPixel, const String& text, const jjANIMATION& animation, const jjTEXTAPPEARANCE& appearance, std::uint8_t param1, std::uint32_t spriteMode, std::uint8_t param2)
param1, jjTEXTAPPEARANCE::xAmp, jjTEXTAPPEARANCE::yAmp, monospace and skipInitialHash are ignored, STRING::SPECIALSIGN works as STRING::HIDESIGN.
void Jazz2::Scripting::Legacy::jjOBJ::grantPickup(jjPLAYER* player, std::int32_t frequency)
player is ignored, the pickup doesn't depend on the player's weapons.
void Jazz2::Scripting::Legacy::jjCANVAS::DrawTextBasicSize(std::int32_t xPixel, std::int32_t yPixel, const String& text, std::uint32_t size, std::uint32_t mode, std::uint8_t param)
PALSHIFT shifts only the replaced frames and ^ drawn as ∞, not the letters of the game font. DARK is a fixed color, and BOUNCE and SPIN move the letters as the menus of the game do.
void Jazz2::Scripting::jjSetModPosition(std::int32_t order, std::int32_t row, bool reset)
reset is ignored, the jump keeps what the music plays at the time, as reset = false does.
std::int32_t Jazz2::Scripting::Legacy::jjPLAYER::buttstomp
Reads only 1 while the player is buttstomping and 50 otherwise, not the phases between.
auto Jazz2::Scripting::getSplitscreenType() -> bool
Returns the value a script assigned, false before that, not how the screen is split.
auto Jazz2::Scripting::Legacy::jjPLAYER::get_antiGrav() const -> bool
Some special moves and vehicles of the game (vines, poles, tubes, the airboard) don't turn with it.
auto Jazz2::Scripting::Legacy::jjOBJ::doesCollidePlayer(const jjPLAYER* object, bool always) const -> bool
auto Jazz2::Scripting::Legacy::jjPLAYER::doesCollide(const jjOBJ* object, bool always) const -> bool
The always parameter is currently ignored.
auto Jazz2::Scripting::Legacy::jjPLAYER::hurt(std::int8_t damage, bool forceHurt, jjPLAYER* attacker) -> bool
The attacker parameter is currently ignored.
void Jazz2::Scripting::jjSetModSpeed(std::uint8_t speed)
void Jazz2::Scripting::jjSetModTempo(std::uint8_t tempo)
The change is heard after the audio already prepared, up to about a third of a second.
auto Jazz2::Scripting::GetEventParamWrapper(std::uint16_t tx, std::uint16_t ty, std::int32_t offset, std::int32_t length) -> std::int32_t
The difficulty bits of the events of a converted level aren't kept, they read 0 unless a script wrote them.
auto Jazz2::Scripting::Legacy::jjPIXELMAP::saveToTile(std::uint16_t tileID, bool hFlip) const -> bool
The flipped versions of a tile always change along with it, so hFlip has no effect.
auto Jazz2::Scripting::Legacy::jjPLAYER::get_spriteMode() const -> std::uint32_t
The game draws the player itself only in its own colors, in any other mode the level draws its frame in that mode once per tick (as jjDrawSprite() would), following the player between ticks.
auto Jazz2::Scripting::Legacy::jjPLAYER::get_scoreDisplayed() const -> std::int32_t
The HUD shows the score without counting up to it, so this is the same value as score and setting either one changes both.
std::int32_t Jazz2::Scripting::Legacy::jjTEXTAPPEARANCE::xAmp
std::int32_t Jazz2::Scripting::Legacy::jjTEXTAPPEARANCE::yAmp
The magnitude is currently not taken into account, and text drawn with a font animation ignores it.
void Jazz2::Scripting::jjAddParticlePixelExplosion(float xPixel, float yPixel, int curFrame, int direction, int mode)
The mode parameter is currently ignored.
void Jazz2::Scripting::SetEventParam(std::uint16_t tx, std::uint16_t ty, int8_t offset, std::int8_t length, std::int32_t newValue)
The parameters of a generator event can't be written, they're refused with a warning.
void Jazz2::Scripting::jjAddParticleTileExplosion(std::uint16_t xTile, std::uint16_t yTile, std::uint16_t tile, bool collapseSceneryStyle)
The pieces and their speeds aren't measured in JJ2+.
auto Jazz2::Scripting::Legacy::jjMASKMAP::save(std::uint16_t tileID, bool hFlip) const -> bool
The rules of jjPIXELMAP::save() for tiles apply, except that the size is always right: flips in tileID flip the mask, hFlip has no effect and animated tiles fail.
auto Jazz2::Scripting::Legacy::jjCOLORMAP::saveToTile(std::uint16_t tileID, bool hFlip) const -> bool
The rules of jjPIXELMAP::save() for tiles apply: the map has to be 32×32, flips in tileID flip the image, hFlip has no effect and animated tiles fail. A palette-indexed tile set (the usual case) loses the true colors and partial alpha.
auto Jazz2::Scripting::Legacy::jjOBJ::unfreeze(std::int32_t style) -> std::int32_t
The shattering ice effect isn't shown currently. The style parameter is currently ignored.
void Jazz2::Scripting::Legacy::jjOBJ::particlePixelExplosion(std::int32_t style)
The style parameter is currently ignored.
void Jazz2::Scripting::Legacy::jjCANVAS::DrawTextExtSize(std::int32_t xPixel, std::int32_t yPixel, const String& text, std::uint32_t size, const jjTEXTAPPEARANCE& appearance, std::uint8_t param1, std::uint32_t mode, std::uint8_t param)
The text is drawn in spriteMode with param2; param1 is ignored. Of the appearance, the other treatments of characters are ignored and the amplitudes only count as zero or non-zero. Only translucent, single color, single hue, shadow, brightness and the BLEND_* modes (as opacity) change the letters of the game font, PALSHIFT doesn't.
void Jazz2::Scripting::Legacy::jjPLAYER::suckerTube(std::int32_t xSpeed, std::int32_t ySpeed, bool center, bool noclip, bool trigSample)
The trigSample parameter is currently ignored.
auto Jazz2::Scripting::setSplitscreenType(bool value) -> bool
The value is only stored, the split follows the player's settings.
auto Jazz2::Scripting::Legacy::jjOBJ::get_isTarget() -> bool
auto Jazz2::Scripting::Legacy::jjOBJ::get_ricochet() -> bool
auto Jazz2::Scripting::Legacy::jjOBJ::get_triggersTNT() -> bool
The value is stored, but the game currently doesn't act on it.
bool Jazz2::Scripting::Legacy::jjTEXTAPPEARANCE::monospace
bool Jazz2::Scripting::Legacy::jjTEXTAPPEARANCE::skipInitialHash

This feature isn't fully implemented, so it may behave differently than described or have no effect at all.

TextureStyleParams Jazz2::Scripting::Legacy::jjLAYER::menu
This style isn't drawn yet, a layer with it is drawn as TEXTURE::WARPHORIZON instead.
auto Jazz2::Scripting::Legacy::jjPLAYER::fireBulletAngle(std::uint8_t gun, bool depleteAmmo, bool requireAmmo, float angle) -> std::int32_t
auto Jazz2::Scripting::Legacy::jjPLAYER::fireBulletDirection(std::uint8_t gun, bool depleteAmmo, bool requireAmmo, std::uint32_t direction) -> std::int32_t
TNT and Thunderbolt aren't fired, it returns 0 for them. A weapon the script doesn't control fires one bullet, without the spread of its powered-up shots.
auto Jazz2::Scripting::Legacy::jjCOLORMAP::CreateFromTexture(std::uint32_t texture, const jjPAL& palette) -> jjCOLORMAP*
True color tiles of TEXTURE::FROMTILES are reduced to the nearest colors of palette.
auto Jazz2::Scripting::Legacy::jjPLAYER::extendInvincibility(std::int32_t duration) -> std::int32_t
While the player blinks, the blinking ends and the invincibility starts from 0.