namespace
ScriptingScripting-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
- class ScriptCollectibleWrapper
- class ScriptLoader
- Generic AngelScript script loader with
#include
and#pragma
directive support. - class ScriptPlayerWrapper
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
Functions
-
auto get_jjObjects(std::
int32_t index) -> jjOBJ* -
auto get_jjObjectPresets(std::
int8_t id) -> jjOBJ* -
void jjAddParticleTileExplosion(std::
uint16_t xTile, std:: uint16_t yTile, std:: uint16_t tile, bool collapseSceneryStyle) - void jjAddParticlePixelExplosion(float xPixel, float yPixel, int curFrame, int direction, int mode)
-
auto GetParticle(std::
int32_t index) -> jjPARTICLE* -
auto AddParticle(std::
int32_t particleType) -> jjPARTICLE* -
auto get_jjPlayerCount() -> std::
int32_t -
auto get_jjLocalPlayerCount() -> std::
int32_t - auto get_jjP() -> jjPLAYER*
-
auto get_jjPlayers(std::
uint8_t index) -> jjPLAYER* -
auto get_jjLocalPlayers(std::
uint8_t index) -> jjPLAYER* - auto mlleSetup() -> bool
- void mlleReapplyPalette()
- void mlleSpawnOffgrids()
- void mlleSpawnOffgridsLocal()
-
auto get_sinTable(std::
uint32_t angle) -> float -
auto get_cosTable(std::
uint32_t angle) -> float -
auto RandWord32() -> std::
uint32_t -
auto unixTimeSec() -> std::
uint64_t -
auto unixTimeMs() -> std::
uint64_t - auto jjRegexIsValid(const String& expression) -> bool
- auto jjRegexMatch(const String& text, const String& expression, bool ignoreCase) -> bool
- auto jjRegexMatchWithResults(const String& text, const String& expression, CScriptArray& results, bool ignoreCase) -> bool
- auto jjRegexSearch(const String& text, const String& expression, bool ignoreCase) -> bool
- auto jjRegexSearchWithResults(const String& text, const String& expression, CScriptArray& results, bool ignoreCase) -> bool
- auto jjRegexReplace(const String& text, const String& expression, const String& replacement, bool ignoreCase) -> String
-
auto GetFPS() -> std::
int32_t - auto isAdmin() -> bool
- auto getLevelFileName() -> String
- auto getCurrLevelName() -> String
- void setCurrLevelName(const String& in)
- auto get_jjTilesetFileName() -> String
-
auto get_gameState() -> std::
int32_t -
auto getBorderWidth() -> std::
int32_t -
auto getBorderHeight() -> std::
int32_t - auto getSplitscreenType() -> bool
- auto setSplitscreenType() -> bool
-
auto get_teamScore(std::
int32_t color) -> std:: int32_t -
auto GetMaxHealth() -> std::
int32_t -
auto GetStartHealth() -> std::
int32_t - void jjSetDarknessColor(jjPALCOLOR color)
-
void jjSetFadeColors(std::
uint8_t red, std:: uint8_t green, std:: uint8_t blue) -
void jjSetFadeColorsFromPalette(std::
uint8_t paletteColorID) - void jjSetFadeColorsFromPalcolor(jjPALCOLOR color)
- auto jjGetFadeColors() -> jjPALCOLOR
- void jjUpdateTexturedBG()
-
auto get_jjTexturedBGTexture(jjPALCOLOR color) -> std::
int32_t -
auto set_jjTexturedBGTexture(std::
int32_t texture) -> std:: int32_t -
auto get_jjTexturedBGStyle() -> std::
int32_t -
auto set_jjTexturedBGStyle(std::
int32_t style) -> std:: int32_t - auto get_jjTexturedBGUsed(jjPALCOLOR color) -> bool
- auto set_jjTexturedBGUsed(bool used) -> bool
- auto get_jjTexturedBGStars(bool used) -> bool
- auto set_jjTexturedBGStars(bool used) -> bool
- auto get_jjTexturedBGFadePositionX() -> float
- auto set_jjTexturedBGFadePositionX(float value) -> float
- auto get_jjTexturedBGFadePositionY() -> float
- auto set_jjTexturedBGFadePositionY(float value) -> float
-
auto getEnabledTeam(std::
uint8_t team) -> bool -
auto getKeyDown(std::
uint8_t key) -> bool -
auto getCursorX() -> std::
int32_t -
auto getCursorY() -> std::
int32_t -
void playSample(float xPixel,
float yPixel,
std::
int32_t sample, std:: int32_t volume, std:: int32_t frequency) -
auto playLoopedSample(float xPixel,
float yPixel,
std::
int32_t sample, std:: int32_t volume, std:: int32_t frequency) -> std:: int32_t -
void playPrioritySample(std::
int32_t sample) -
auto isSampleLoaded(std::
int32_t sample) -> bool -
auto loadSample(std::
int32_t sample, const String& filename) -> bool - auto getUseLayer8Speeds() -> bool
- auto setUseLayer8Speeds(bool value) -> bool
- auto get_jjWEAPON(int index) -> jjWEAPON*
- auto get_jjCHARACTER(int index) -> jjCHARACTER*
-
auto GetEvent(std::
uint16_t tx, std:: uint16_t ty) -> std:: int32_t -
auto GetEventParamWrapper(std::
uint16_t tx, std:: uint16_t ty, std:: int32_t offset, std:: int32_t length) -> std:: int32_t -
void SetEventByte(std::
uint16_t tx, std:: uint16_t ty, std:: uint8_t newEventId) -
void SetEventParam(std::
uint16_t tx, std:: uint16_t ty, int8_t offset, std:: int8_t length, std:: int32_t newValue) -
auto GetTileType(std::
uint16_t tile) -> std:: int8_t -
auto SetTileType(std::
uint16_t tile, std:: uint16_t value) -> std:: int8_t -
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 -
auto jjTileSet(std::
uint8_t layer, std:: int32_t xTile, std:: int32_t yTile, std:: uint16_t newTile) -> std:: uint16_t -
void jjGenerateSettableTileArea(std::
uint8_t layer, std:: int32_t xTile, std:: int32_t yTile, std:: int32_t width, std:: int32_t height) -
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 -
auto jjMaskedHLine(std::
int32_t xPixel, std:: int32_t lineLength, std:: int32_t yPixel) -> bool -
auto jjMaskedHLineLayer(std::
int32_t xPixel, std:: int32_t lineLength, std:: int32_t yPixel, std:: uint8_t layer) -> bool -
auto jjMaskedVLine(std::
int32_t xPixel, std:: int32_t yPixel, std:: int32_t lineLength) -> bool -
auto jjMaskedVLineLayer(std::
int32_t xPixel, std:: int32_t yPixel, std:: int32_t lineLength, std:: uint8_t layer) -> bool -
auto jjMaskedTopVLine(std::
int32_t xPixel, std:: int32_t yPixel, std:: int32_t lineLength) -> bool -
auto jjMaskedTopVLineLayer(std::
int32_t xPixel, std:: int32_t yPixel, std:: int32_t lineLength, std:: uint8_t layer) -> bool -
void jjSetModPosition(std::
int32_t order, std:: int32_t row, bool reset) -
void jjSlideModChannelVolume(std::
int32_t channel, float volume, std:: int32_t milliseconds) -
auto jjGetModOrder() -> std::
int32_t -
auto jjGetModRow() -> std::
int32_t -
auto jjGetModTempo() -> std::
int32_t -
void jjSetModTempo(std::
uint8_t speed) -
auto jjGetModSpeed() -> std::
int32_t -
void jjSetModSpeed(std::
uint8_t speed) -
auto getCustomSetID(std::
uint8_t index) -> std:: uint32_t - 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
Specifies a part to be drawn in LevelScriptLoader::
enum class Jazz2:: Scripting:: ScriptContextType
#include <Jazz2/Scripting/ScriptLoader.h>
Script context type.
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::
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 HashMap<dictKey_ t, CScriptDictValue> Jazz2:: Scripting:: dictMap_t
Function documentation
jjOBJ* Jazz2:: Scripting:: get_jjObjects(std:: int32_t index)
jjOBJ* Jazz2:: Scripting:: get_jjObjectPresets(std:: int8_t id)
void Jazz2:: Scripting:: jjAddParticleTileExplosion(std:: uint16_t xTile,
std:: uint16_t yTile,
std:: uint16_t tile,
bool collapseSceneryStyle)
void Jazz2:: Scripting:: jjAddParticlePixelExplosion(float xPixel,
float yPixel,
int curFrame,
int direction,
int mode)
jjPARTICLE* Jazz2:: Scripting:: GetParticle(std:: int32_t index)
jjPARTICLE* Jazz2:: Scripting:: AddParticle(std:: int32_t particleType)
std:: int32_t Jazz2:: Scripting:: get_jjPlayerCount()
std:: int32_t Jazz2:: Scripting:: get_jjLocalPlayerCount()
jjPLAYER* Jazz2:: Scripting:: get_jjPlayers(std:: uint8_t index)
jjPLAYER* Jazz2:: Scripting:: get_jjLocalPlayers(std:: uint8_t index)
bool Jazz2:: Scripting:: mlleSetup()
void Jazz2:: Scripting:: mlleReapplyPalette()
void Jazz2:: Scripting:: mlleSpawnOffgrids()
void Jazz2:: Scripting:: mlleSpawnOffgridsLocal()
float Jazz2:: Scripting:: get_sinTable(std:: uint32_t angle)
float Jazz2:: Scripting:: get_cosTable(std:: uint32_t angle)
std:: uint32_t Jazz2:: Scripting:: RandWord32()
std:: uint64_t Jazz2:: Scripting:: unixTimeSec()
std:: uint64_t Jazz2:: Scripting:: unixTimeMs()
bool Jazz2:: Scripting:: jjRegexIsValid(const String& expression)
bool Jazz2:: Scripting:: jjRegexMatch(const String& text,
const String& expression,
bool ignoreCase)
bool Jazz2:: Scripting:: jjRegexMatchWithResults(const String& text,
const String& expression,
CScriptArray& results,
bool ignoreCase)
bool Jazz2:: Scripting:: jjRegexSearch(const String& text,
const String& expression,
bool ignoreCase)
bool Jazz2:: Scripting:: jjRegexSearchWithResults(const String& text,
const String& expression,
CScriptArray& results,
bool ignoreCase)
String Jazz2:: Scripting:: jjRegexReplace(const String& text,
const String& expression,
const String& replacement,
bool ignoreCase)
std:: int32_t Jazz2:: Scripting:: GetFPS()
bool Jazz2:: Scripting:: isAdmin()
String Jazz2:: Scripting:: getLevelFileName()
String Jazz2:: Scripting:: getCurrLevelName()
void Jazz2:: Scripting:: setCurrLevelName(const String& in)
String Jazz2:: Scripting:: get_jjTilesetFileName()
std:: int32_t Jazz2:: Scripting:: get_gameState()
std:: int32_t Jazz2:: Scripting:: getBorderWidth()
std:: int32_t Jazz2:: Scripting:: getBorderHeight()
bool Jazz2:: Scripting:: getSplitscreenType()
bool Jazz2:: Scripting:: setSplitscreenType()
std:: int32_t Jazz2:: Scripting:: get_teamScore(std:: int32_t color)
std:: int32_t Jazz2:: Scripting:: GetMaxHealth()
std:: int32_t Jazz2:: Scripting:: GetStartHealth()
void Jazz2:: Scripting:: jjSetDarknessColor(jjPALCOLOR color)
void Jazz2:: Scripting:: jjSetFadeColors(std:: uint8_t red,
std:: uint8_t green,
std:: uint8_t blue)
void Jazz2:: Scripting:: jjSetFadeColorsFromPalette(std:: uint8_t paletteColorID)
void Jazz2:: Scripting:: jjSetFadeColorsFromPalcolor(jjPALCOLOR color)
jjPALCOLOR Jazz2:: Scripting:: jjGetFadeColors()
void Jazz2:: Scripting:: jjUpdateTexturedBG()
std:: int32_t Jazz2:: Scripting:: get_jjTexturedBGTexture(jjPALCOLOR color)
std:: int32_t Jazz2:: Scripting:: set_jjTexturedBGTexture(std:: int32_t texture)
std:: int32_t Jazz2:: Scripting:: get_jjTexturedBGStyle()
std:: int32_t Jazz2:: Scripting:: set_jjTexturedBGStyle(std:: int32_t style)
bool Jazz2:: Scripting:: get_jjTexturedBGUsed(jjPALCOLOR color)
bool Jazz2:: Scripting:: set_jjTexturedBGUsed(bool used)
bool Jazz2:: Scripting:: get_jjTexturedBGStars(bool used)
bool Jazz2:: Scripting:: set_jjTexturedBGStars(bool used)
float Jazz2:: Scripting:: get_jjTexturedBGFadePositionX()
float Jazz2:: Scripting:: set_jjTexturedBGFadePositionX(float value)
float Jazz2:: Scripting:: get_jjTexturedBGFadePositionY()
float Jazz2:: Scripting:: set_jjTexturedBGFadePositionY(float value)
bool Jazz2:: Scripting:: getEnabledTeam(std:: uint8_t team)
bool Jazz2:: Scripting:: getKeyDown(std:: uint8_t key)
std:: int32_t Jazz2:: Scripting:: getCursorX()
std:: int32_t Jazz2:: Scripting:: getCursorY()
void Jazz2:: Scripting:: playSample(float xPixel,
float yPixel,
std:: int32_t sample,
std:: int32_t volume,
std:: int32_t frequency)
std:: int32_t Jazz2:: Scripting:: playLoopedSample(float xPixel,
float yPixel,
std:: int32_t sample,
std:: int32_t volume,
std:: int32_t frequency)
void Jazz2:: Scripting:: playPrioritySample(std:: int32_t sample)
bool Jazz2:: Scripting:: isSampleLoaded(std:: int32_t sample)
bool Jazz2:: Scripting:: loadSample(std:: int32_t sample,
const String& filename)
bool Jazz2:: Scripting:: getUseLayer8Speeds()
bool Jazz2:: Scripting:: setUseLayer8Speeds(bool value)
jjWEAPON* Jazz2:: Scripting:: get_jjWEAPON(int index)
jjCHARACTER* Jazz2:: Scripting:: get_jjCHARACTER(int index)
std:: int32_t Jazz2:: Scripting:: GetEvent(std:: uint16_t tx,
std:: uint16_t ty)
std:: int32_t Jazz2:: Scripting:: GetEventParamWrapper(std:: uint16_t tx,
std:: uint16_t ty,
std:: int32_t offset,
std:: int32_t length)
void Jazz2:: Scripting:: SetEventByte(std:: uint16_t tx,
std:: uint16_t ty,
std:: uint8_t newEventId)
void Jazz2:: Scripting:: SetEventParam(std:: uint16_t tx,
std:: uint16_t ty,
int8_t offset,
std:: int8_t length,
std:: int32_t newValue)
std:: int8_t Jazz2:: Scripting:: GetTileType(std:: uint16_t tile)
std:: int8_t Jazz2:: Scripting:: SetTileType(std:: uint16_t tile,
std:: uint16_t value)
std:: uint16_t Jazz2:: Scripting:: jjGetStaticTile(std:: uint16_t tileID)
std:: uint16_t Jazz2:: Scripting:: jjTileGet(std:: uint8_t layer,
std:: int32_t xTile,
std:: int32_t yTile)
std:: uint16_t Jazz2:: Scripting:: jjTileSet(std:: uint8_t layer,
std:: int32_t xTile,
std:: int32_t yTile,
std:: uint16_t newTile)
void Jazz2:: Scripting:: jjGenerateSettableTileArea(std:: uint8_t layer,
std:: int32_t xTile,
std:: int32_t yTile,
std:: int32_t width,
std:: int32_t height)
bool Jazz2:: Scripting:: jjMaskedPixel(std:: int32_t xPixel,
std:: int32_t yPixel)
bool Jazz2:: Scripting:: jjMaskedPixelLayer(std:: int32_t xPixel,
std:: int32_t yPixel,
std:: uint8_t layer)
bool Jazz2:: Scripting:: jjMaskedHLine(std:: int32_t xPixel,
std:: int32_t lineLength,
std:: int32_t yPixel)
bool Jazz2:: Scripting:: jjMaskedHLineLayer(std:: int32_t xPixel,
std:: int32_t lineLength,
std:: int32_t yPixel,
std:: uint8_t layer)
bool Jazz2:: Scripting:: jjMaskedVLine(std:: int32_t xPixel,
std:: int32_t yPixel,
std:: int32_t lineLength)
bool Jazz2:: Scripting:: jjMaskedVLineLayer(std:: int32_t xPixel,
std:: int32_t yPixel,
std:: int32_t lineLength,
std:: uint8_t layer)
bool Jazz2:: Scripting:: jjMaskedTopVLine(std:: int32_t xPixel,
std:: int32_t yPixel,
std:: int32_t lineLength)
bool Jazz2:: Scripting:: jjMaskedTopVLineLayer(std:: int32_t xPixel,
std:: int32_t yPixel,
std:: int32_t lineLength,
std:: uint8_t layer)
void Jazz2:: Scripting:: jjSetModPosition(std:: int32_t order,
std:: int32_t row,
bool reset)
void Jazz2:: Scripting:: jjSlideModChannelVolume(std:: int32_t channel,
float volume,
std:: int32_t milliseconds)
std:: int32_t Jazz2:: Scripting:: jjGetModOrder()
std:: int32_t Jazz2:: Scripting:: jjGetModRow()
std:: int32_t Jazz2:: Scripting:: jjGetModTempo()
void Jazz2:: Scripting:: jjSetModTempo(std:: uint8_t speed)
std:: int32_t Jazz2:: Scripting:: jjGetModSpeed()
void Jazz2:: Scripting:: jjSetModSpeed(std:: uint8_t speed)
std:: uint32_t Jazz2:: Scripting:: getCustomSetID(std:: uint8_t index)
void Jazz2:: Scripting:: RegisterArray(asIScriptEngine* engine)
#include <Jazz2/Scripting/RegisterArray.h>
Registers array
type to AngelScript engine.
void Jazz2:: Scripting:: RegisterDictionary(asIScriptEngine* engine)
Registers dictionary
type to AngelScript engine.
void Jazz2:: Scripting:: RegisterImGuiBindings(asIScriptEngine* engine)
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::string
type to AngelScript engine.