From d91a0c4467c051ed23f8870303802becdca612dc Mon Sep 17 00:00:00 2001
From: Axanery <41282531+Axanery@users.noreply.github.com>
Date: Mon, 22 Apr 2024 00:33:56 -0400
Subject: [PATCH] Update Documentation.htm
---
guides/Documentation.htm | 160 ++++++++-------------------------------
1 file changed, 31 insertions(+), 129 deletions(-)
diff --git a/guides/Documentation.htm b/guides/Documentation.htm
index 045af0b6..4486a6bb 100644
--- a/guides/Documentation.htm
+++ b/guides/Documentation.htm
@@ -561,7 +561,6 @@
- Resources.LoadSprite
- - Resources.LoadSpriteByFolder
+ - Resources.LoadDynamicSprite
- Resources.LoadImage
- Resources.LoadFont
- Resources.LoadModel
@@ -861,8 +862,6 @@ Scene
- Scene.CheckObjectCollisionBox
- Scene.CheckObjectCollisionPlatform
- Scene.Load
- - Scene.LoadNoPersistency
- - Scene.LoadPosition
- Scene.Change
- Scene.LoadTileCollisions
- Scene.AreTileCollisionsLoaded
@@ -904,12 +903,10 @@ Scene
- Scene.GetTileFlipY
- Scene.GetDrawGroupCount
- Scene.GetDrawGroupEntityDepthSorting
- - Scene.GetListPos
- Scene.GetCurrentFolder
- Scene.GetCurrentID
- Scene.GetCurrentResourceFolder
- Scene.GetCurrentCategory
- - Scene.GetActiveCategory
- Scene.GetDebugMode
- Scene.GetFirstInstance
- Scene.GetLastInstance
@@ -925,14 +922,8 @@ Scene
- Scene.IsCurrentEntryValid
- Scene.IsUsingFolder
- Scene.IsUsingID
- - Scene.CheckValidScene
- - Scene.CheckSceneFolder
- - Scene.CheckSceneID
- Scene.IsPaused
- - Scene.SetListPos
- - Scene.SetActiveCategory
- Scene.SetDebugMode
- - Scene.SetScene
- Scene.SetTile
- Scene.SetTileCollisionSides
- Scene.SetPaused
@@ -1365,7 +1356,6 @@ Instance
- instance.InView
- instance.CollidedWithObject
- instance.GetHitboxFromSprite
- - instance.ReturnHitboxFromSprite
- instance.CollideWithObject
- instance.SolidCollideWithObject
- instance.TopSolidCollideWithObject
@@ -4944,6 +4934,28 @@ Math.Clamp
Returns:
Returns the Number value if within the range, otherwise returns closest range value.
+
+
Math.ToFixed
+ Math.ToFixed(n)
+ Converts a decimal number to its fixed-point equivalent.
+ Parameters:
+
+ - n (Number): Number value.
+
+ Returns:
+ Returns the converted fixed-point Number value.
+
+
+
Math.FromFixed
+ Math.FromFixed(n)
+ Converts a fixed-point number to its decimal equivalent.
+ Parameters:
+
+ - n (Number): Number value.
+
+ Returns:
+ Returns the converted decimal Number value.
+
Math.Sign
Math.Sign(n)
@@ -5970,10 +5982,10 @@ Resources.LoadSprite
Returns:
Returns the index of the Resource.
-
-
Resources.LoadSpriteByFolder
- Resources.LoadSpriteByFolder(fallbackFolder, name, unloadPolicy)
- Loads a Sprite resource via the current Scene's resource folder (else a fallback folder) if a scene list is loaded.
+
+
Resources.LoadDynamicSprite
+ Resources.LoadDynamicSprite(fallbackFolder, name, unloadPolicy)
+ Loads a Sprite resource via the current Scene's resource folder if a scene list is loaded (else a fallback folder).
Parameters:
- fallbackFolder (String): Folder to check if the sprite does not exist in the current Scene's resource folder.
@@ -6187,24 +6199,6 @@ Scene.Load
- persistency (Boolean): Whether or not the scene should load with persistency.
-
-
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:
-
- - filename (String): Filename of scene.
-
-
-
-
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:
-
- - persistency (Boolean): Whether or not the scene should load with persistency.
-
-
Scene.Change
Scene.Change(category, scene)
@@ -6604,13 +6598,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()
@@ -6632,13 +6619,6 @@ Scene.GetCurrentResourceFolder
Returns:
Returns a String value.
-
-
Scene.GetCurrentSpriteFolder
- Scene.GetCurrentSpriteFolder()
-
- Returns:
- Returns a String value.
-
Scene.GetCurrentCategory
Scene.GetCurrentCategory()
@@ -6646,13 +6626,6 @@ Scene.GetCurrentCategory
Returns:
Returns a String value.
-
-
Scene.GetActiveCategory
- Scene.GetActiveCategory()
-
- Returns:
- Returns an Integer value.
-
Scene.GetDebugMode
Scene.GetDebugMode()
@@ -6786,35 +6759,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:
-
- - folder (String): Folder name to compare.
-
- 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:
-
- - id (String): ID to compare.
-
- Returns:
- Returns a Boolean value.
-
Scene.IsPaused
Scene.IsPaused()
@@ -6822,39 +6766,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:
-
- - sceneNum (Integer): Scene number to use.
-
-
-
-
Scene.SetActiveCategory
- Scene.SetActiveCategory(categoryNum)
-
- Parameters:
-
- - categoryNum (Integer): Scene category number to use.
-
-
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:
-
- - category (String): Category name.
- - scene (String): Scene name. If the scene name is not found but the category name is, the first scene in the category is used.
-
-
Scene.SetTile
Scene.SetTile(layer, cellX, cellY, tileID, flipX, flipY[, collisionMaskA, collisionMaskB])
@@ -9567,7 +9483,7 @@ XML.Parse
Returns:
Returns a Map value if the text can be decoded, otherwise returns null
.
- 694 out of 753 functions have descriptions.
+ 691 out of 750 functions have descriptions.
Instance methods
@@ -9663,20 +9579,6 @@
instance.GetHitboxFromSprite
- hitbox (Integer): The hitbox ID.
- Gets the hitbox in the specified sprite's animation, frame and hitbox ID.
- Returns an array containing the hitbox top, left, right and bottom sides in that order.
-
Stops all sounds the entity is playing.
- 25 out of 25 methods have descriptions.
+ 24 out of 24 methods have descriptions.