diff --git a/CMakeLists.txt b/CMakeLists.txt index 0051b96a..8bc3b97f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -189,7 +189,7 @@ endif() if(${CMAKE_SYSTEM_NAME} MATCHES "Windows") if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC") target_link_libraries(${PROJECT_NAME} "${CMAKE_CURRENT_LIST_DIR}/meta/win/lib/msvc/x64/SDL2.lib" - Ws2_32.lib opengl32.lib) + Ws2_32.lib opengl32.lib winmm.lib imm32.lib version.lib setupapi.lib) else() target_link_libraries(${PROJECT_NAME} "${CMAKE_CURRENT_LIST_DIR}/meta/win/lib/mingw/${TOOLCHAIN_PREFIX}/libSDL2.a" diff --git a/VisualC/HatchGameEngine.sln b/VisualC/HatchGameEngine.sln index 15d8b17c..88fbcd5f 100644 --- a/VisualC/HatchGameEngine.sln +++ b/VisualC/HatchGameEngine.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 16 -VisualStudioVersion = 16.0.31112.23 +# Visual Studio Version 17 +VisualStudioVersion = 17.9.34622.214 MinimumVisualStudioVersion = 10.0.40219.1 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "HatchGameEngine", "HatchGameEngine.vcxproj", "{EE5F89ED-FA81-458F-A2D2-3370351D9E23}" EndProject @@ -15,8 +15,8 @@ Global GlobalSection(ProjectConfigurationPlatforms) = postSolution {EE5F89ED-FA81-458F-A2D2-3370351D9E23}.Debug|x64.ActiveCfg = Debug|x64 {EE5F89ED-FA81-458F-A2D2-3370351D9E23}.Debug|x64.Build.0 = Debug|x64 - {EE5F89ED-FA81-458F-A2D2-3370351D9E23}.Debug|x86.ActiveCfg = Debug|Win32 - {EE5F89ED-FA81-458F-A2D2-3370351D9E23}.Debug|x86.Build.0 = Debug|Win32 + {EE5F89ED-FA81-458F-A2D2-3370351D9E23}.Debug|x86.ActiveCfg = Release|x64 + {EE5F89ED-FA81-458F-A2D2-3370351D9E23}.Debug|x86.Build.0 = Release|x64 {EE5F89ED-FA81-458F-A2D2-3370351D9E23}.Release|x64.ActiveCfg = Release|x64 {EE5F89ED-FA81-458F-A2D2-3370351D9E23}.Release|x64.Build.0 = Release|x64 {EE5F89ED-FA81-458F-A2D2-3370351D9E23}.Release|x86.ActiveCfg = Release|Win32 diff --git a/VisualC/HatchGameEngine.vcxproj b/VisualC/HatchGameEngine.vcxproj index 76a10fef..4379a8dc 100644 --- a/VisualC/HatchGameEngine.vcxproj +++ b/VisualC/HatchGameEngine.vcxproj @@ -80,6 +80,7 @@ $(SolutionDir)..\meta\win\include;$(SolutionDir)..\include;$(SolutionDir)..\source;$(IncludePath) $(SolutionDir)..\meta\win\lib\msvc\x64;$(LibraryPath) + true @@ -119,19 +120,36 @@ - stdcpp17 + stdcpp20 + WIN32;TARGET_NAME="$(ProjectName)";GLEW_STATIC;USING_OPENGL;USING_FREETYPE;_DEBUG;_WINDOWS;DEBUG;%(PreprocessorDefinitions) + MultiThreadedDebugDLL copy "$(TargetPath)" "$(SolutionDir)..\builds\win\$(TargetName)-Debug.exe" + + Ws2_32.lib;Wldap32.lib;Advapi32.lib;Crypt32.lib;Normaliz.lib;legacy_stdio_definitions.lib;glew32s.lib;opengl32.lib;freetype.lib;SDL2.lib;SDL2main.lib;winmm.lib;imm32.lib;version.lib;setupapi.lib;assimp.lib;zlibstatic.lib;%(AdditionalDependencies) + Console + + + - stdcpp17 + stdcpp20 + WIN32;TARGET_NAME="$(ProjectName)";GLEW_STATIC;USING_OPENGL;USING_FREETYPE;USING_ASSIMP;NDEBUG;_WINDOWS;%(PreprocessorDefinitions) + MultiThreaded copy "$(TargetPath)" "$(SolutionDir)..\builds\win\$(TargetName)-Release.exe" + + Console + Ws2_32.lib;Wldap32.lib;Advapi32.lib;Crypt32.lib;Normaliz.lib;legacy_stdio_definitions.lib;glew32s.lib;opengl32.lib;freetype.lib;SDL2.lib;SDL2main.lib;winmm.lib;imm32.lib;version.lib;setupapi.lib;ucrt.lib;vcruntime.lib;msvcrt.lib;assimp.lib;zlibstatic.lib;%(AdditionalDependencies) + + + libvcruntime.lib + @@ -310,4 +328,4 @@ - + \ No newline at end of file diff --git a/VisualC/HatchGameEngine.vcxproj.filters b/VisualC/HatchGameEngine.vcxproj.filters index d8c447fa..6e404920 100644 --- a/VisualC/HatchGameEngine.vcxproj.filters +++ b/VisualC/HatchGameEngine.vcxproj.filters @@ -381,6 +381,36 @@ Source Files\External Libs + + Source Files + + + Source Files + + + Source Files + + + Source Files + + + Source Files + + + Source Files + + + Source Files + + + Source Files + + + Source Files + + + Source Files + @@ -464,9 +494,6 @@ Header Files - - Header Files - Header Files @@ -494,6 +521,9 @@ Source Files\External Libs + + Header Files + diff --git a/desktop.ini b/desktop.ini new file mode 100644 index 00000000..64d70198 --- /dev/null +++ b/desktop.ini @@ -0,0 +1,6 @@ +[.ShellClassInfo] +IconResource=C:\Users\Austin\Documents\Projects\HatchGameEngine\meta\win\icon.ico,0 +[ViewState] +Mode= +Vid= +FolderType=Documents diff --git a/guides/Documentation.htm b/guides/Documentation.htm index 3fd2639f..4f121b8b 100644 --- a/guides/Documentation.htm +++ b/guides/Documentation.htm @@ -50,6 +50,7 @@

Namespaces

  • Application
  • Array
  • Audio
  • +
  • Collision
  • Controller
  • Date
  • Device
  • @@ -121,7 +122,7 @@

    Enums

  • FogEquation_*
  • GeoBooleanOp_*
  • GeoFillRule_*
  • -
  • HitboxSide_*
  • +
  • HITBOX_*
  • InputBind_*
  • InputDevice_*
  • KeyBind_*
  • @@ -133,9 +134,9 @@

    Enums

  • StencilOp_*
  • StencilTest_*
  • TILECOLLISION_*
  • -
  • TimeOfDay_*
  • +
  • TIMEOFDAY_*
  • TintMode_*
  • -
  • Weekday_*
  • +
  • WEEKDAY_*
  • Constants

    @@ -233,10 +241,12 @@

    Application

  • Application.GetGameTitleShort
  • Application.GetGameVersion
  • Application.GetGameDescription
  • +
  • Application.GetReservedSlotIDs
  • Application.SetGameTitle
  • Application.SetGameTitleShort
  • Application.SetGameVersion
  • Application.SetGameDescription
  • +
  • Application.SetReservedSlotIDs
  • Application.SetCursorVisible
  • Application.GetCursorVisible
  • @@ -270,6 +280,19 @@

    Audio

  • Audio.SetSoundVolume
  • +

    +

    Collision

    + Class methods: + +

    Controller

    Class methods: @@ -375,6 +398,7 @@

    Draw

  • Draw.Text
  • Draw.TextWrapped
  • Draw.TextEllipsis
  • +
  • Draw.TextArray
  • Draw.SetBlendColor
  • Draw.SetTextureBlend
  • Draw.SetBlendMode
  • @@ -415,6 +439,10 @@

    Draw

  • Draw.UseStrokeSmoothing
  • Draw.SetClip
  • Draw.ClearClip
  • +
  • Draw.GetClipX
  • +
  • Draw.GetClipY
  • +
  • Draw.GetClipWidth
  • +
  • Draw.GetClipHeight
  • Draw.Save
  • Draw.Scale
  • Draw.Rotate
  • @@ -637,6 +665,7 @@

    Instance

  • instance.ScaleY
  • instance.Rotation
  • instance.Alpha
  • +
  • instance.BlendMode
  • instance.Priority
  • instance.Depth
  • instance.Sprite
  • @@ -649,6 +678,8 @@

    Instance

  • instance.AnimationLoopIndex
  • instance.AnimationSpeedMult
  • instance.AnimationSpeedAdd
  • +
  • instance.PrevAnimation
  • +
  • instance.RotationStyle
  • instance.AutoAnimate
  • instance.OnScreen
  • instance.WasOffScreen
  • @@ -656,6 +687,7 @@

    Instance

  • instance.OnScreenHitboxH
  • instance.ViewRenderFlag
  • instance.ViewOverrideFlag
  • +
  • instance.Visible
  • instance.UpdateRegionW
  • instance.UpdateRegionH
  • instance.UpdateRegionTop
  • @@ -726,6 +758,10 @@

    Math

  • Math.Max
  • Math.Clamp
  • Math.Sign
  • +
  • Math.Uint8
  • +
  • Math.Uint16
  • +
  • Math.Uint32
  • +
  • Math.Uint64
  • Math.Random
  • Math.RandomMax
  • Math.RandomRange
  • @@ -735,6 +771,8 @@

    Math

  • Math.Sqrt
  • Math.Pow
  • Math.Exp
  • +
  • RSDK.Math.ToFixed
  • +
  • RSDK.Math.FromFixed
  • @@ -774,14 +812,11 @@

    Music

    Class methods: @@ -881,6 +917,7 @@

    Resources

    Class methods:

    @@ -1713,13 +1741,13 @@

    GeoFillRule_*

  • GeoFillRule_Negative
  • -

    -

    HitboxSide_*

    +

    +

    HITBOX_*

    @@ -1935,13 +1963,13 @@

    TILECOLLISION_*

  • TILECOLLISION_UP
  • -

    -

    TimeOfDay_*

    +

    +

    TIMEOFDAY_*

    @@ -1953,16 +1981,16 @@

    TintMode_*

  • TintMode_DST_BLEND
  • -

    -

    Weekday_*

    +

    +

    WEEKDAY_*

    Constants

    @@ -1971,8 +1999,15 @@

    Globals

    Class methods

    Animator.Create

    - Animator.Create() + Animator.Create(sprite, animationID, frameID, unloadPolicy)
    Creates a new animator.
    +
    Parameters:
    +
    Returns:
    Returns the index of the Animator.

    @@ -2052,9 +2087,9 @@

    Animator.GetHitbox

    Returns:
    Returns a reference value to a hitbox array.

    -

    -

    Animator.GetPreviousAnimation

    - Animator.GetPreviousAnimation(animator) +

    +

    Animator.GetPrevAnimation

    + Animator.GetPrevAnimation(animator)
    Gets the previous animation value of an animator.
    Parameters:

    +

    +

    Animator.SetPrevAnimation

    + Animator.SetPrevAnimation(animator, prevAnimation) +
    Sets the previous frame of an animator.
    +
    Parameters:
    + +

    Animator.SetAnimationSpeed

    Animator.SetAnimationSpeed(animator, animationSpeed) @@ -2178,6 +2234,36 @@

    Animator.SetDuration

  • duration (Integer): The animator's changed duration.
  • +

    +

    Animator.SetFrameCount

    + Animator.SetFrameCount(animator, frameCount) +
    Sets the frame count of an animator.
    +
    Parameters:
    + +

    +

    +

    Animator.SetLoopIndex

    + Animator.SetLoopIndex(animator, loopIndex) +
    Sets the loop index of an animator.
    +
    Parameters:
    + +

    +

    +

    Animator.SetRotationStyle

    + Animator.SetRotationStyle(animator, rorationStyle) +
    Sets the rotation style of an animator.
    +
    Parameters:
    + +

    Animator.AdjustCurrentAnimation

    Animator.AdjustCurrentAnimation(animator, amount) @@ -2228,6 +2314,26 @@

    Animator.AdjustDuration

  • amount (Integer): The amount to adjust the animator's duration.
  • +

    +

    Animator.AdjustFrameCount

    + Animator.AdjustFrameCount(animator, amount) +
    Adjusts the frame count of an animator by an amount.
    +
    Parameters:
    + +

    +

    +

    Animator.AdjustLoopIndex

    + Animator.AdjustLoopIndex(animator, amount) +
    Adjusts the loop index of an animator by an amount.
    +
    Parameters:
    + +

    Application.GetCommandLineArguments

    Application.GetCommandLineArguments() @@ -2346,6 +2452,15 @@

    Application.GetGameDescription

    Application.GetGameDescription()
    Gets the description of the game.

    +

    +

    Application.GetReservedSlotIDs

    + Application.GetReservedSlotIDs(amount) +
    Sets the number of reserved slot IDs the engine will use when creating instances.
    +
    Parameters:
    + +

    Application.SetGameTitle

    Application.SetGameTitle(title) @@ -2382,6 +2497,15 @@

    Application.SetGameDescription

  • title (String): Game description.
  • +

    +

    Application.SetReservedSlotIDs

    + Application.SetReservedSlotIDs(amount) +
    Sets the number of reserved slot IDs the engine will use when creating instances.
    +
    Parameters:
    + +

    Application.SetCursorVisible

    Application.SetCursorVisible(cursorVisible) @@ -2563,6 +2687,109 @@

    Audio.SetSoundVolume

  • volume (Integer): The sound effect volume, from 0 to 100.
  • +

    +

    Collision.ProcessObjectMovement

    + Collision.ProcessObjectMovement(entity, outer, inner) +
    Processes movement of an instance with an outer hitbox and an inner hitbox.
    +
    Parameters:
    + +

    +

    +

    Collision.ObjectTileCollision

    + Collision.ObjectTileCollision(entity, cLayers, cMode, cPlane, xOffset, yOffset, setPos) +
    Checks tile collision based on where an instance should check.
    +
    Parameters:
    + +
    Returns:
    +
    Returns whether the instance has collided with a tile.
    +

    +

    +

    Collision.ObjectTileGrip

    + Collision.ObjectTileGrip(entity, cLayers, cMode, cPlane, xOffset, yOffset, tolerance) +
    Keeps an instance gripped to tile collision based on where an instance should check.
    +
    Parameters:
    + +
    Returns:
    +
    Returns whether to grip the instance.
    +

    +

    +

    Collision.CheckObjectCollisionTouch

    + Collision.CheckObjectCollisionTouch(thisEntity, thisHitbox, otherEntity, otherHitbox) +
    Checks if an instance is touching another instance with their respective hitboxes.
    +
    Parameters:
    + +
    Returns:
    +
    Returns a Boolean value whether the entities are touching.
    +

    +

    +

    Collision.CheckObjectCollisionCircle

    + Collision.CheckObjectCollisionCircle(thisEnity, thisRadius, otherEntity, otherRadius) +
    Checks if an instance is touching another instance with within their respective radii.
    +
    Parameters:
    + +
    Returns:
    +
    Returns a Boolean value whether the entities have collided.
    +

    +

    +

    Collision.CheckObjectCollisionBox

    + Collision.CheckObjectCollisionBox(thisEnity, thisHitbox, otherEntity, otherHitbox, setValues) +
    Checks if an instance is touching another instance with their respective hitboxes and sets the values of the other instance if specified.
    +
    Parameters:
    + +
    Returns:
    +
    Returns the side the entities are colliding on.
    +

    +

    +

    Collision.CheckObjectCollisionPlatform

    + Collision.CheckObjectCollisionPlatform(thisEnity, thisHitbox, otherEntity, otherHitbox, setValues) +
    Checks if an instance is touching the top of another instance with their respective hitboxes and sets the values of the other instance if specified.
    +
    Parameters:
    + +
    Returns:
    +
    Returns a Boolean value whether the entities have collided.
    +

    Controller.GetCount

    Controller.GetCount() @@ -2971,12 +3198,13 @@

    Draw.Sprite

    Draw.SpriteBasic

    - Draw.SpriteBasic(instance[, sprite]) + Draw.SpriteBasic(instance[, x, y])
    Draws a sprite based on an entity's current values (Sprite, CurrentAnimation, CurrentFrame, X, Y, Direction, ScaleX, ScaleY, Rotation).
    Parameters:

    @@ -2997,12 +3225,14 @@

    Draw.Animator

    Draw.AnimatorBasic

    - Draw.AnimatorBasic(animator, instance[, sprite]) + Draw.AnimatorBasic(animator, instance[, x, y, sprite])
    Draws an animator based on its current values (Sprite, CurrentAnimation, CurrentFrame) and an entity's other values (X, Y, Direction, ScaleX, ScaleY, Rotation).
    Parameters:

    @@ -3317,6 +3547,25 @@

    Draw.TextWrapped

    Draw.TextEllipsis

    Draw.TextEllipsis()

    +

    +

    Draw.TextArray

    + Draw.TextArray(sprite, animation, x, y, string, startFrame, endFrame, align, spacing[, charOffsetsX, charOffsetsY]) +
    Draws a series of sprites based on a converted sprite string.
    +
    Parameters:
    + +

    Draw.SetBlendColor

    Draw.SetBlendColor(hex, alpha) @@ -3769,6 +4018,34 @@

    Draw.ClearClip

    Draw.ClearClip()
    Resets the drawing region.

    +

    +

    Draw.GetClipX

    + Draw.GetClipX() +
    Gets the X position in which drawing starts to occur.
    +
    Returns:
    +
    The X position if clipping is enabled, else 0.
    +

    +

    +

    Draw.GetClipY

    + Draw.GetClipY() +
    Gets the Y position in which drawing starts to occur.
    +
    Returns:
    +
    The Y position if clipping is enabled, else 0.
    +

    +

    +

    Draw.GetClipWidth

    + Draw.GetClipWidth() +
    Gets the width in which drawing occurs.
    +
    Returns:
    +
    The width if clipping is enabled, else 0.
    +

    +

    +

    Draw.GetClipHeight

    + Draw.GetClipHeight() +
    Gets the height in which drawing occurs.
    +
    Returns:
    +
    The height if clipping is enabled, else 0.
    +

    Draw.Save

    Draw.Save() @@ -5177,7 +5454,7 @@

    Instance.IsClass

    Determines whether or not the instance is of a specified object class.
    Parameters:
    Returns:
    @@ -5437,6 +5714,50 @@

    Math.Sign

    Returns:
    Returns -1 if n is negative, 1 if positive, and 0 if otherwise.

    +

    +

    Math.Uint8

    + Math.Uint8(n) +
    Converts an integer to an 8-bit unsigned value.
    +
    Parameters:
    + +
    Returns:
    +
    Returns the converted value.
    +

    +

    +

    Math.Uint16

    + Math.Uint16(n) +
    Converts an integer to a 16-bit unsigned value.
    +
    Parameters:
    + +
    Returns:
    +
    Returns the converted value.
    +

    +

    +

    Math.Uint32

    + Math.Uint32(n) +
    Converts an integer to a 32-bit unsigned value.
    +
    Parameters:
    + +
    Returns:
    +
    Returns the converted value.
    +

    +

    +

    Math.Uint64

    + Math.Uint64(n) +
    Converts an integer to a 64-bit unsigned value.
    +
    Parameters:
    + +
    Returns:
    +
    Returns the converted value.
    +

    Math.Random

    Math.Random() @@ -5534,6 +5855,28 @@

    Math.Exp

    Returns:
    Returns the result number.

    +

    +

    RSDK.Math.ToFixed

    + RSDK.Math.ToFixed(n) +
    Converts a decimal number to its fixed-point equivalent.
    +
    Parameters:
    + +
    Returns:
    +
    Returns the converted fixed-point Number value.
    +

    +

    +

    RSDK.Math.FromFixed

    + RSDK.Math.FromFixed(n) +
    Converts a fixed-point number to its decimal equivalent.
    +
    Parameters:
    + +
    Returns:
    +
    Returns the converted decimal Number value.
    +

    Matrix.Create

    Matrix.Create() @@ -5758,29 +6101,17 @@

    Model.DeleteArmature

    Music.Play

    - Music.Play(music[, panning, speed, volume, fadeInAfterFinished]) + Music.Play(music[, loopPoint, panning, speed, volume, startPoint, fadeInAfterFinished])
    Places the music onto the music stack and plays it.
    Parameters:
    -

    -

    -

    Music.PlayAtTime

    - Music.PlayAtTime(music, startPoint[, panning, speed, volume, fadeInAfterFinished]) -
    Places the music onto the music stack and plays it at a time (in seconds).
    -
    Parameters:
    -

    @@ -5789,7 +6120,7 @@

    Music.Stop

    Removes the music from the music stack, stopping it if currently playing.
    Parameters:

    @@ -5816,37 +6147,6 @@

    Music.Clear

    Music.Clear()
    Completely clears the music stack, stopping all music.

    -

    -

    Music.Loop

    - Music.Loop(music, loop, loopPoint[, panning, speed, volume, fadeInAfterFinished]) -
    Places the music onto the music stack and plays it, looping back to the specified sample index if it reaches the end of playback.
    -
    Parameters:
    - -

    -

    -

    Music.LoopAtTime

    - Music.LoopAtTime(music, startPoint, loop, loopPoint[, panning, speed, volume, fadeInAfterFinished]) -
    Places the music onto the music stack and plays it, looping back to the specified sample index if it reaches the end of playback.
    -
    Parameters:
    - -

    Music.IsPlaying

    Music.IsPlaying(music) @@ -6285,6 +6585,18 @@

    RSDK.Math.ACos256

    Returns:
    The arc cosine 256 of the angle.

    +

    +

    RSDK.Math.ATan2

    + RSDK.Math.ATan2(x, y) +
    Returns the arc tangent of a position.
    +
    Parameters:
    + +
    Returns:
    +
    The arc tangent of the position.
    +

    RSDK.Math.RadianToInteger

    RSDK.Math.RadianToInteger(radian) @@ -6299,7 +6611,7 @@

    RSDK.Math.RadianToInteger

    RSDK.Math.IntegerToRadian

    RSDK.Math.IntegerToRadian(integer) -
    Gets the radia Decimal conversion of an integer, based on 256.
    +
    Gets the radian Decimal conversion of an integer, based on 256.
    Parameters:

    -

    -

    Scene.LoadNoPersistency

    - Scene.LoadNoPersistency(filename) -
    Changes active scene to the one in the specified resource file, without keeping any persistent objects. (Deprecated; use Scene.Load instead.)
    -
    Parameters:
    - -

    -

    -

    Scene.LoadPosition

    - Scene.LoadPosition([persistency]) -
    Loads the scene located in the scene list's position slot, if a scene list is loaded. (Deprecated; use Scene.Load instead.)
    -
    Parameters:
    - -

    Scene.Change

    Scene.Change(category, scene) @@ -7073,13 +7277,6 @@

    Scene.GetDrawGroupEntityDepthSorting

    Returns:
    Returns a Boolean value.

    -

    -

    Scene.GetListPos

    - Scene.GetListPos() -
    Gets the current list position of the scene. (Deprecated; use Scene_ListPos instead.)
    -
    Returns:
    -
    Returns an Integer value.
    -

    Scene.GetCurrentFolder

    Scene.GetCurrentFolder() @@ -7101,13 +7298,6 @@

    Scene.GetCurrentResourceFolder

    Returns:
    Returns a String value.

    -

    -

    Scene.GetCurrentSpriteFolder

    - Scene.GetCurrentSpriteFolder() -
    Gets the current sprite folder of the scene. (Deprecated; use Scene.GetCurrentResourceFolder instead.)
    -
    Returns:
    -
    Returns a String value.
    -

    Scene.GetCurrentCategory

    Scene.GetCurrentCategory() @@ -7115,27 +7305,6 @@

    Scene.GetCurrentCategory

    Returns:
    Returns a String value.

    -

    -

    Scene.GetActiveCategory

    - Scene.GetActiveCategory() -
    Gets the current category number of the scene. (Deprecated; use Scene_ActiveCategory instead.)
    -
    Returns:
    -
    Returns an Integer value.
    -

    -

    -

    Scene.GetCategoryCount

    - Scene.GetCategoryCount() -
    Gets the amount of categories in the scene list. (Deprecated; use SceneList.GetCategoryCount instead.)
    -
    Returns:
    -
    Returns an Integer value.
    -

    -

    -

    Scene.GetStageCount

    - Scene.GetStageCount() -
    Gets the amount of stages in the scene list. (Deprecated; use SceneList.GetSceneCount instead.)
    -
    Returns:
    -
    Returns an Integer value.
    -

    Scene.GetDebugMode

    Scene.GetDebugMode() @@ -7269,35 +7438,6 @@

    Scene.IsUsingID

    Returns:
    Returns a Boolean value.

    -

    -

    Scene.CheckValidScene

    - Scene.CheckValidScene() -
    Checks whether the scene list's position is within the list's size, if a scene list is loaded. (Deprecated; use Scene.IsCurrentEntryValid instead.)
    -
    Returns:
    -
    Returns a Boolean value.
    -

    -

    -

    Scene.CheckSceneFolder

    - Scene.CheckSceneFolder(folder) -
    Checks whether the current scene's folder matches the string to check, if a scene list is loaded. (Deprecated; use Scene.IsUsingFolder instead.)
    -
    Parameters:
    - -
    Returns:
    -
    Returns a Boolean value.
    -

    -

    -

    Scene.CheckSceneID

    - Scene.CheckSceneID(id) -
    Checks whether the current scene's ID matches the string to check, if a scene list is loaded. (Deprecated; use Scene.IsUsingID instead.)
    -
    Parameters:
    - -
    Returns:
    -
    Returns a Boolean value.
    -

    Scene.IsPaused

    Scene.IsPaused() @@ -7305,39 +7445,11 @@

    Scene.IsPaused

    Returns:
    Returns a Boolean value.

    -

    -

    Scene.SetListPos

    - Scene.SetListPos(sceneNum) -
    Sets the current list position of the scene. (Deprecated; use Scene_ListPos instead.)
    -
    Parameters:
    - -

    -

    -

    Scene.SetActiveCategory

    - Scene.SetActiveCategory(categoryNum) -
    Sets the current category number of the scene. (Deprecated; use Scene_ActiveCategory instead.)
    -
    Parameters:
    - -

    Scene.SetDebugMode

    Scene.SetDebugMode()
    Sets whether Debug Mode has been turned on in the current scene.

    -

    -

    Scene.SetScene

    - Scene.SetScene(category, scene) -
    Sets the scene if the category and scene names exist within the scene list. (Deprecated; use Scene.Change instead.)
    -
    Parameters:
    - -

    Scene.SetTile

    Scene.SetTile(layer, cellX, cellY, tileID, flipX, flipY[, collisionMaskA, collisionMaskB]) @@ -8572,6 +8684,19 @@

    Sprite.GetAnimationIndexByName

    Returns:
    Returns the first animation index with the specified name, or -1 if there was no match.

    +

    +

    Sprite.GetFrameExists

    + Sprite.GetFrameExists(sprite, animation, frame) +
    Checks if an animation and frame is valid within a sprite.
    +
    Parameters:
    + +
    Returns:
    +
    Returns the first animation index with the specified name, or -1 if there was no match.
    +

    Sprite.GetFrameLoopIndex

    Sprite.GetFrameLoopIndex(sprite, animation) @@ -8686,20 +8811,45 @@

    Sprite.GetFrameOffsetY

    Returns:
    Returns the Y offset of the specified sprite frame.

    -

    -

    Sprite.GetFrameHitbox

    - Sprite.GetFrameHitbox(sprite, animationID, frame, hitboxID) -
    Gets the hitbox of an animation and frame of a sprite.
    +

    +

    Sprite.GetHitbox

    + Sprite.GetHitbox(instance, sprite, animationID, frameID, hitboxID) +
    Gets the hitbox of a sprite frame. If an entity is provided, the only two arguments are the entity and the hitboxID. Else, there are 4 arguments.
    Parameters:
    Returns:
    Returns a reference value to a hitbox array.

    +

    +

    Sprite.SetSpriteString

    + Sprite.SetSpriteString(sprite, animation, string) +
    Converts a string to an array of sprite indexes by comparing UTF-16 values to a frame's ID.
    +
    Parameters:
    + +

    +

    +

    Sprite.GetStringWidth

    + Sprite.GetStringWidth(sprite, animation, string, startIndex, spacing) +
    Gets the width (in pixels) of a converted sprite string.
    +
    Parameters:
    + +

    Sprite.MakePalettized

    Sprite.MakePalettized(sprite, paletteIndex) @@ -9113,15 +9263,16 @@

    String.Split

    String.CharAt

    - String.CharAt(string, index) -
    Gets the UTF8 value of the character at the specified index.
    + String.CharAt(string, index[, utf16]) +
    Gets the value of the character at the specified index.
    Parameters:
    Returns:
    -
    Returns the UTF8 value as an Integer.
    +
    Returns the value as an Integer.

    String.Length

    @@ -9183,9 +9334,9 @@

    String.Substring

    Returns:
    Returns a String value.

    -

    -

    String.ToUpperCase

    - String.ToUpperCase(string) +

    +

    String.ToUppercase

    + String.ToUppercase(string)
    Convert a String value to its uppercase representation.
    Parameters: