Stone Story RPG · ·:·: Stonescript (Beta) :·:· · v3.49.5 - 2023/10/28 intro | manual | beta ·:· release notes | faq _ ______________________ _ ,:´ \____ __.---,. `. :.! __________\_______\__`--`´__ \ :' \ \--------------------------.\ \ ':' · \ ·:. :'· :.:· \\ \ ':' \ \ :·' :·:. \\ \ ':' · \ .: ·:: '.:. ':'··:. \\ \ ':' \ \ · :.. \\ \ ':' · \ :·: ..': :·:. ·:: '. \\ \ ':' \ \__________________________\\ \ ':' ` . \ . ) ':' . . . \ . . . . ' . . . . \ . .; `·.;,;,;,;,;,;,;,;,;,;,;,;,;,;,:' Used in the Mind Stone to automate equipment choices. Stonescript is a minimalistic, yet powerful language inside of Stone Story RPG. Need help? Want to collaborate on scripts? Visit our Discord. This manual is the comprehensive reference of all available Stonescript features. Most of the examples can be copy/pasted directly into the Mind Stone, which is a great way to learn how they work. ·:·:· Index ·:·:· 1. Example 2. Basics 3. Game State 4. Commands 5. Search Filters 6. Comparisons 7. Variables 8. Math Operations 9. Functions 10. Native Functions 11. Importing External Scripts 12. ASCII-art 13. Loops 14. Arrays 15. Custom Input 16. User Interface 17. Tips 18. Default script 19. Roadmap Appendix A - Sound Effects Appendix B - Music Appendix C - Ambient Loops ·:·:· Example ·:·:· // Equips the Shovel for Rocky Plateau. // In Caves of Fear it equips loadout 1, // except against the boss, where the // Grappling Hook and a 7 star War Hammer // are used instead. // For Haunted Halls it uses two Wands, // specifying Poison for left hand and // Vigor for the right hand. However, // if the difficulty is over 5 stars it // uses an enchanted +13 Vigor Staff. // Potion activates if hitpoints fall // below 10 ?loc=rocky equip shovel ?loc=cave loadout 1 ?foe=bolesh equip grap equip hammer *7 D ?loc=halls equipL poison wand equipR vigor wand ?loc.stars > 5 equip vigor staff +13 ?hp < 10 activate potion ^Back to top ·:·:· Basics ·:·:· ? Evaluates a logical condition. If true, executes indented lines (if). E.g. ?loc = caves loadout 1 : Alternative logical branch, in case the '?' condition is false (else). E.g. ?loc = caves loadout 1 : loadout 2 :? Alternative logical branch, with additional conditions (else-if). E.g. ?loc = caves loadout 1 :?loc = deadwood loadout 2 : loadout 3 // A comment. All text to the right of '//' has no logical effect when the script executes. E.g. ?loc = caves loadout 1 //The above equips loadout 1 for Caves of Fear /* */ Block comment. All text between the symbols has no logical effect when the script executes. E.g. /* ?loc = caves loadout 1 */ This script does nothing, as all of it is inside the block comments. ^ Continue previous line. E.g. ?loc=caves | ^loc = mine equip repeating //The above is equal to: ?loc=caves|loc=mine equip repeating ^Back to top ·:·:· Game State ·:·:· These questions tell you what's happening and what's right in front of the player. ?loc The current location the player is visiting. E.g. ?loc = caves loadout 1 ?loc.id The unique identifier of the current location. E.g. var id id = loc.id >Exploring @id@ ?loc.name The localized name of the current location. E.g. >Exploring @loc.name@ ?loc.stars The current location's difficulty. E.g. ?loc = caves ?loc.stars=4 loadout 1 ?loc.stars=5 loadout 2 ?loc.begin Is true only on the first frame of a location, when time = 0, before any game simulation has run. Is not true after an Ouroboros loop. Useful for resetting variables. E.g. var i ?loc.begin i = 0 ?loc = caves i = -100 ?loc.loop Is true on the first frame of a run after an Ouroboros loop. E.g. var loopCount = 0 ?loc.loop loopCount++ ?loc.isQuest True if the current location is a special location from a Legend or custom quest. False otherwise. E.g. ?loc.isQuest >`0,1,We're in a special quest location loc.averageTime The current location's average completion time. A location's average time is calculated in a weighted manner, where the latest completion time is worth more and older times are worth progressively less the older they are. E.g. >`0,2,Average time = ^ @loc.averageTime@ frames loc.bestTime The current location's best completion time (your record, high-score). E.g. >`0,1,Best time = ^ @loc.bestTime@ frames ?foe The current foe being targeted by the player. E.g. ?foe = boo equip vigor staff ?foe.id The unique ID (or type) of the foe being targeted by the player. ?foe.name The localized name of the foe being targeted by the player. ?foe.damage The damage per attack of the foe being targeted by the player. E.g. >`0,1,foe damage = @foe.damage@ ?foe.distance The distance between the player and the foe being targeted. ?foe.count The number of foes within 46 units of the player. ?foe.GetCount(int) The number of foes within a specific number of units. ?foe.hp The current hitpoints of the foe being targeted by the player. ?foe.maxhp The maximum hitpoints of the foe being targeted by the player. ?foe.armor The current armor of the foe being targeted by the player. ?foe.maxarmor The maximum armor of the foe being targeted by the player. ?foe.buffs.count The number of buffs (positive effects) on the foe being targeted. ?foe.buffs.string A composite of information about all the buffs on the target foe. E.g. ?foe.buffs.count > 0 >`0,3,Foe buffs = @foe.buffs.string@ ?buffs.oldest The ID of the oldest buff on the player E.g. >`0,1,Oldest buff: @buffs.oldest@ ?foe.debuffs.count The number of debuffs (negative effects) on the foe being targeted. ?foe.debuffs.string A composite of information about all the debuffs on the target foe. E.g. ?foe.debuffs.count > 0 >`0,4,Foe debuffs = @foe.debuffs.string@ ?debuffs.oldest The ID of the oldest debuff on the player E.g. >`0,1,Oldest debuff: @debuffs.oldest@ ?foe.state A number representing the target foe's current state. E.g. ?foe.state = 0 >`0,0,Foe is asleep ?foe.time Elapsed number of frames in target foe's current state. E.g. >`0,0,Foe = @foe.name@:@foe.state@,@foe.time@ ?foe.level The level number of the target foe. E.g. >`0,0,Foe = @foe.name@ is level @foe.level@ ?harvest The next harvestable object, such as a tree or boulder. E.g. ?harvest=Boulder equip shovel ?harvest.distance The distance between the player and the nearest harvestable object. E.g. ?loc=Rocky & harvest.distance < 7 equip shovel ?input.x The X position, on the ASCII grid, of the input device (mouse/touch). ?input.y The Y position, on the ASCII grid, of the input device (mouse/touch). E.g. > (@input.x@, @input.y@) ?item.left The item equipped to the left hand. E.g. >`0,1,Left:@item.left@ >`0,2,Right:@item.right@ ?item.right The item equipped to the right hand. E.g. ?item.right = quarterstaff activate R ?item.left.id ?item.right.id The ID of the item equipped to the left or right hand. E.g. >`0,1,Left ID:@item.left.id@ >`0,2,Right ID:@item.right.id@ ?item.left.state ?item.left.time ?item.right.state ?item.right.time The numeric representation for an equipped weapon's current state and elapsed frames within that state. E.g. >`0,1,@item.left.state@:@item.left.time@ >`0,2,@item.right.state@:@item.right.time@ ?item.potion The potion currently brewed. Includes "auto" if auto-refill is enabled on the Cauldron. E.g. ?item.potion ! empty & item.potion = auto activate potion ?pickup The current pickup being targeted by the player. E.g. ?pickup equip star stone : loadout 1 ?pickup.distance The distance between the player and the pickup being targeted. E.g. ?pickup.distance < 5 equipL star stone ?armor The player's current armor, rounded down. E.g. if the armor says [2.4] ?armor evaluates to 2. ?armor.f The player's current armor's fractional amount. E.g. if the armor says [2.4] ?armor.f evaluates to 4. ?buffs.count The number of buffs (positive effects) on the player. ?buffs.string A composite of information about all buffs on the player. E.g. ?buffs.count > 0 >`0,1,Player buffs = @buffs.string@ ?debuffs.count The number of debuffs (negative effects) on the player. ?debuffs.string A composite of information about all debuffs on the player. E.g. ?debuffs.count > 0 >`0,2,Player debuffs = @debuffs.string@ ?hp The player's current hitpoints. ?maxhp The player's maximum hitpoints. ?maxarmor The player's maximum armor, rounded down. ?pos.x The player's current X position. ?pos.y The player's current Y position. ?pos.z The player's current Z position. ?ai.enabled True if the AI is on, False if the AI is off (e.g. during a cinematic moment). ?ai.paused True if the AI is temporarily suspended, such as when waiting for a treasure to drop. ?ai.idle True if the player is idle, waiting for something such as an attack to complete. ?ai.walking True if the player is moving. ?bighead True if the player has Big Head enabled (Moondial). ?face The player's current facial expression. E.g. ?face = "^^" >Happy ?key The state of custom game input. The following prints the current input: >@key@ ?res.stone ?res.wood ?res.tar ?res.ki ?res.bronze ?res.crystals The player's current amount of resources in their inventory. E.g. ?loc = Deadwood >Wood = @res.wood@ E.g.2 >`0,1,#magenta, ♦ @res.crystals@ ?player.direction Indicates the direction in which the player is facing. Returns a value of 1 for right and -1 for left. E.g. ?player.direction = 1 >`0,0,Walking right : >`0,0,Walking left player.name The name chosen by the player. This example prints the player's name above their head: var name var x name = player.name x = string.Size(name) / -2 >o@x@,-2,@name@ ?rng Returns a random integer between 0 and 9999. E.g. ?rng < 5000 >Heads! : >Tails! E.g.2: Generates a random integer between 5 and 24: var min = 5 var max = 24 var n = min + rng % (max - min + 1) ?rngf Returns a random floating-point number between 0 and 1. E.g. >random float = @rngf@ E.g.2: Generates a random float between 5.0 and 24.0: var min = 5.0 var max = 24.0 var n = min + (max - min) * rngf ?screen.i The screen's position in-game, as an index that increses when the player reaches the right-side and it slides over. E.g. >`0,0,Screen index = @screen.i@ ?screen.x The screen's position in-game. E.g. >`0,0,Screen position X = @screen.x@ ?screen.w The width of the screen's ASCII grid. E.g. var sw = screen.w >Screen width = @sw@ ?screen.h The height of the screen's ASCII grid. E.g. var sh = screen.h >Screen height = @sh@ ?summon.count The number of summoned allies currently in game. E.g. ?summon.count = 0 equipL talisman activate L summon.GetId(index = 0) Returns the ID of the summon at a given index. The index parameter is optional and defaults to zero (first summon). Returns null if no summons are at that index. E.g. ?summon.GetId() ! "cinderwisp" equipR fire talisman activate R summon.GetName(index = 0) Returns the localized name of the summon at a given index. The index parameter is optional and defaults to zero (first summon). Returns null if no summons are at that index. E.g. >`0,1,Summon:@summon.GetName()@ summon.GetVar(varName, index = 0) Returns the value for a custom variable on a summon. Different types of summons expose different variables, based on their unique abilities. The index parameter is optional and defaults to zero (first summon). Returns null if no summons are at that index. Shows an error if varName does not correspond to a valid variable. E.g. ?summon.GetId() = cinderwisp & ^summon.GetVar("ignition") > 2 activate cinderwisp summon.GetState(index = 0) Returns a number representing the current state of a summon. The index parameter is optional and defaults to zero (first summon). Returns -1 if no summons are at that index. E.g. >`0,1,Summon state:@summon.GetState()@ summon.GetTime(index = 0) Returns the elapsed number of frames in the current state of a summon. The index parameter is optional and defaults to zero (first summon). Returns -1 if no summons are at that index. E.g. >`0,1,Summon time:@summon.GetTime()@ ?totalgp The total "Gear Points" of your inventory, calculated from item star levels and enchantment bonuses. E.g. >My gear points = @totalgp@ ?time The current frame number of the location. E.g. ?time % 300 = 0 >Every 10 seconds you'll see this message ?totaltime The current frame number of the location, accumulated in case of boss sub-location. E.g. >`0,0,Current time = @totaltime@ frames time.msbn Unix time represents the number of milliseconds that have elapsed since 1970-01-01T00:00:00Z (January 1, 1970, at 12:00 AM UTC). It does not take leap seconds into account. Returns a BigNumber E.g. >@time.msbn@ time.year, time.month, time.day, time.hour, time.minute, time.second The local system time on the player's computer. E.g. >`0,0,@time.year@/@time.month@/@time.day@ ^ @time.hour@:@time.minute@:@time.second@ utc.year, utc.month, utc.day, utc.hour, utc.minute, utc.second The current UTC time. E.g. var utcZ = utc.year*356*12*24*30 + ^utc.month*12*24 + utc.day*24+utc.hour var timeZ = time.year*356*12*24*30 + ^time.month*12*24 + time.day*24+time.hour var timeZone = timeZ - utcZ ?timeZone < 0 >`0,0,Time Zone: UTC@timeZone@ : >`0,0,Time Zone: UTC+@timeZone@ ^Back to top ·:·:· Commands ·:·:· These tell the game to do something. activate (ability) Activates an item ability. (ability) can have these values: potion, P, left, L, right, R. E.g. activate R (activates the ability of the item equipped on the right side, such as the Hatchet) brew (ingredients) Refills the potion bottle to the specified combination of ingredients. Executes only at the beginning of a run, at time 0. Ingredients can be stone, wood, tar or bronze and should be separated by +. Ingredient names can be written in English or in the language selected in the settings. E.g. ?loc.begin brew bronze + tar equip (str) Equips an item. (str) has a limit of 7 criteria. Two-handed items must use this form of the equip command. E.g. equip vigor crossbow *8 +5 equipL (str) Equips an item to the left hand that best fits the given criteria. E.g. equipL poison d_sword equipR (str) Equips an item to the right hand that best fits the given criteria. E.g. equipR vigor shield equip @var@ Equips an item based on criteria from a string variable. Equip and other item search commands support subtractive criteria. E.g. var weaponName = "poison sword *10 -big" equipR @weaponName@ loadout (n) Equips a specific loadout number. E.g. ?loc = caves loadout 1 ?loc = deadwood loadout 2 > (str) Prints a string to the top of the screen. E.g. >Hello World! > @varName@ Prints a string with the value of a variable inserted. Multiple variables can be inserted into a single print. To insert, surround the variable's name with @. The following example prints information about the currently targeted foe: var foeInfo foeInfo = foe >FOE = @foeInfo@ >(abcd Shows a custom facial expression on the player. Requires Big Head. E.g. >( OwO >oX,Y,[#rrggbb,](str) Advanced print relative to the player's position. X and Y are the coordinate offsets. #rrggbb is the color of the text in hexadecimal notation. Color can also be set with these constants: #white, #cyan, #yellow, #green, #blue and #red. To print in rainbow use #rainFF where the last 2 characters define the brightness. The following example writes "Let's go!" in red font, relative to the player's position, 6 to the left and 3 down: >o-6,3,#red,Let's go! >hX,Y,[#rrggbb,](str) Similar to ">o", however, draws on the same layer as the Big Head. Ideal for accessories such as hats. The following draws a yellow hat on the player. Works best if Big Head is enabled: >h-2,-3,#yellow,ascii ##_ #| | _|_|_ asciiend >`X,Y,[#rrggbb,](str) Advanced print relative to the upper-left corner of the screen. The following prints "Hello World!", but uses variables for the coordinates and the color: var posX = 10 var posY = 5 var color = rainE1 >`@posX@,@posY@,#@color@,Hello World! >cX,Y,[#rrggbb,](str) Advanced print relative to the center of the screen. Similar to ">`". Note that in all these the color is optional. This example demonstrates how the color is optional and defaults to white: >c0,0,Hello World! >fX,Y,[#rrggbb,](str) Advanced print relative to the target foe's head position. The following draws a red crosshairs on the targeted foe: >f-2,0,#ff0000,ascii ##! -#·#- ##¡ asciiend var (variable) Declares a variable that can be used in math, logical and string operations. See the variables section for details about their lifecycle and behavior, that may differ from other languages. E.g. var message = Hello World! >@message@ func (function) Declares a function that can be called later. E.g. func Print(message) >@message@ Print(Hello World!) for v = a..b Creates a loop that iterates a variable 'v' from value 'a' to value 'b'. Code that appears inside the loop's scope will run multiple times. E.g. var a a = 0 for i = 1..5 a = a + i >a = @a@ import (script) Loads and executes a singular copy of an external script. This example imports the fishing mini-game located at (save-file folder)/Stonescript/Fishing.txt import Fishing new (script) Loads and executes an external script similar to 'import'. However, objects loaded with 'new' are each an individual copy and their script body will only execute one time. This example creates and prints a vector object: var v = new Components/Vector v.Init(10, 5) >Vector = @v@ disable abilities Prevents activation of potion and weapon abilities. Also greys out the HUD buttons. enable abilities Restores activation of abilities that were disabled by a previous call to "disable abilities". disable banner Prevents rendering of the horizontal banner that appears with the location name at the beginning and end of a location. enable banner Restores rendering of the horizontal banner with location name. disable hud (opts) Hides and disables the gameplay user interface elements. Accepts optional parameters, specifying the set of elements to disable: p = player health and debuffs, f = foe health and debuffs, a = ability buttons, r = resources, b = banner, u = utility belt. E.g. disable hud // Disables all hud elements E.g.2 disable hud ru // Disables only resources (r) and utility belt (u) enable hud (opts) Brings back the user interface elements hidden by previous "disable hud" commands. Accepts the same optional parameters as the disable command. disable loadout input Prevents weapon loadouts from being saved or recalled with input keys. enable loadout input Restores the saving or recalling of weapon loadouts by means of input keys. disable loadout print Hides the messages that appear when a loadout is recalled. enable loadout print Brings back the printing of loadout messages. disable pause Hides the pause button user interface. Pause is still available with the [P] shortcut. enable pause Brings back the pause button hidden by a previous "disable pause" command. disable player Hides the player. Has no effect on combat, this is only cosmetic. enable player Brings back the player rendering if it was hidden by a previous "disable player" command. play (sound) (pitch) Plays a sound effect with an optional pitch value. The pitch default value is 100 with higher numbers increasing the pitch and smaller numbers lowering it. E.g. ?key = primary play buy ?key = up play buy 200 E.g.2: var pitch ?time%30 = 0 pitch = rng/100 + 50 >@pitch@ play buy @pitch@ ^Back to top ·:·:· Search Filters ·:·:· These are used when evaluating foes, locations and items. E.g.: ?foe = insect | foe = poison loadout 3 poison vigor aether fire air ice arachnid serpent insect machine humanoid elemental boss phase1 phase2 phase3 spawner flying slow ranged explode swarm unpushable undamageable magic_resist magic_vulnerability immune_to_stun immune_to_ranged immune_to_debuff_damage immune_to_physical *[number] star level (location or item) +[number] enchantment bonus (item only) ^Back to top ·:·:· Comparisons ·:·:· Used in conjunction with game state to make decisions = Compares values equal or string contains. E.g. ?hp = maxhp loadout 2 ! Compares values not equal or string does not contain. E.g. ?foe ! poison equipL sword & Logical AND operator. E.g. ?loc=caves & foe=boss | Logical OR operator. If '&' and '|' are mixed in a single complex expression, all '&' operate first. E.g. ?foe=slow | foe.count>3 activate potion > Greater-than compare. Can be used with a location's difficulty, number of foes, health, etc. E.g. ?foe.count > 10 equip shiny bardiche < Less-than compare. E.g. ?hp < 6 activate potion >= Greater-than or equal compare. The combination of '>' and '=' into a single comparison. The following two examples are equivalent: ?loc.stars >= 6 equipR vigor shield ?loc.stars > 6 | loc.stars = 6 equipR vigor shield <= Less-than or equal compare. The combination of '<' and '=' into a single comparison. E.g. ?hp <= 6 activate potion ^Back to top ·:·:· Variables ·:·:· Variables are a way of storing value to use later. Declare a new variable with the keyword 'var'. E.g.: var myVar = 10 (myVar is the name of the variable, and it's initialized with value 10) myVar = myVar + 5 (myVar now equals 15) var secondVar = 3 myVar = myVar - secondVar (Many variables can be combined in math operations. myVar now equals 12) When a variable is declared it is initialized only once, the first time 'var' executes. E.g.: var i = 0 i++ >i = @i@ In this example, variable 'i' is declared and starts with value 0. During each frame of the run, the value of 'i' increases by 1 and then is printed to the screen. Variables only reset to their initial value if you leave a location and begin a new run manually. They do not reset when the Ouroboros loops or when the Mind Stone is opened then closed again. String variables can optionally be declared with quotes. This allows special symbols and trailing spaces. E.g.: var a = 10 var b = 5 var myVar = a + " x " + b + " = " + (a * b) >@myVar@ (This example also demonstrates how to join strings with the '+' operator) Variables in imported scripts are contained within those scripts and their names won't collide with variables or functions in other scripts. ^Back to top ·:·:· Math Operations ·:·:· Operators modify numbers. Can be used in conjunction with variables or directly in game state expressions. + Adds two numbers or variables together. E.g.: var a = 2 + 3 (a equals 5) - Subtracts two numbers or variables from each other. E.g.: ?hp < maxhp - 5 equip vigor sword dL * Multiplies two numbers or variables together. E.g.: var a = 2 var b = 5 a = a * b // a equals 10 E.g.2: var a = 2 * 0.4 // a equals 0.8 / Divides one number or variable by another. In the case of integers, the result is rounded down. E.g.: var a = 8 a = a / 4 // a equals 2 E.g.2: var a = 5.0 a = a / 2 // a equals 2.5 ++ Increments a variable. E.g.: var a = 3 a++ // a equals 4 -- Decrements a variable. E.g.: var a = 3 a-- // a equals 2 % Modulo. Gives the remainder of dividing one number by another. E.g.: var a = 5 % 4 (a equals 1) E.g.2: ?time % 8 < 4 > \O) ?time % 8 > 3 > (O/ // this draws an animated emoji ( ) Parenthesis can be used to prioritize operations. E.g.: var a = 2 * (3 - 1) // a equals 4 ! Negation. Inverts the value when used in front of a boolean expression. E.g.: ? !ai.enabled >The AI is not enabled. ^Back to top ·:·:· Functions ·:·:· Custom functions serve an important organizational purpose to scripts as they grow in complexity. They make scripts easier to read and reduce repetition. When a function is declared its contents are not executed immediately. Instead, lines of script inside a function execute when the function is called at a later point. This example creates a counter that increases by 1 each frame. When any custom input key is pressed, ResetCounter() is called and the counter value goes back to zero: var count = 0 count++ >Counter = @count@ func ResetCounter() count = 0 ?key=begin ResetCounter() Another aspect of functions is that they can return a value. In this example we declare a simple function that calculates the duration of the main location (non-boss area): func NonBossDuration() return totalTime - time var duration duration = NonBossDuration() >Time was: @duration@ Functions also accept any number of arguments/parameters, making them even more powerful, with the ability to operate on arbitrary input. Here, we declare a utility function that generates a random number within a range, then we use it to generate random numbers between 5 and 10: func RandomRange(min, max) ?min >= max return min return min + rng % (max - min + 1) var randomValue randomValue = RandomRange(5, 10) >RNG: @randomValue@ The prefix 'this' can be used inside a funtion when referencing variables that belong to the outside script. Use of 'this' is optional, and script variables can be accessed by a function without the prefix. However, in the following example the variable 'a' appears both inside and outside of the function, so 'this.a' is used for differentiation: var a = 1 func TestScope(a) >Script var = @this.a@, function var = @a@ TestScope(3) When functions call other functions, or themselves, this creates an execution stack that can build in size until the application crashes. To safeguard computer resources Stonescript has a stack limit of 215 and will throw an error if the limit is exceeded. ^Back to top ·:·:· Native Functions ·:·:· While scripts can define their own functions, Stonescript comes with a set of pre-defined/native functions that behave similar to commands, but differ in that they are more clearly grouped by subject, can accept parameters and sometimes return a value. ambient ‾‾‾‾‾‾‾ ?ambient Return string Returns a comma-separated list of all active ambient audio IDs. E.g. >`0,0,Ambient Layers = @ambient@ ambient.Add(str) No return value Adds a layer of ambient audio, with the given sound ID. Up to 4 layers. If a 5th layer is added, the oldest layer is removed. E.g. ?loc.begin ambient.Add(ambient_crypt) ambient.Stop() No return value Clears all ambient layers. E.g. ?time = 3 ambient.Stop() ambient.Add(ambient_mines) BigNumber ‾‾‾‾‾‾‾‾‾ BigNumbers are a special type of object that provide a way to work with large integers that exceed 32 bits. While they can only hold positive and negative whole number values, their arithmetic and comparison operations work with floats as well as integers and other BigNumbers. b.Add(num) b.Add(BigNumber) Returns itself Adds a number to a BigNumber (+) E.g. var bn = math.BigNumber(12) bn.Add(5) >@bn@ // 17 b.Sub(num) b.Sub(BigNumber) Returns itself Subtracts a number from a BigNumber (-) E.g. var bn = math.BigNumber(12) bn.Sub(5) >@bn@ // 7 b.Mul(num) b.Mul(BigNumber) Returns itself Multiplies a BigNumber by a number (*) E.g. var myBigNum1 = math.BigNumber(12) var myBigNum2 = math.BigNumber(12) myBigNum1.Mul(5) myBigNum2.Mul(1.5) >@myBigNum1@ @myBigNum2@ // 60 18 b.Div(num) b.Div(BigNumber) Returns itself Divides a BigNumber by a number (/) E.g. var myBigNum1 = math.BigNumber(12) var myBigNum2 = math.BigNumber(12) myBigNum1.Div(5) myBigNum2.Div(1.5) >@myBigNum1@ @myBigNum2@ // 2 8 b.Eq(num) b.Eq(BigNumber) Returns bool Determines if a BigNumber is equal to a number (=) E.g. var bn = math.BigNumber(5) >@bn.Eq(5)@ @bn.Eq(3)@ // true false b.Gt(num) b.Gt(BigNumber) Returns bool Determines if a BigNumber is greater than a number (>) E.g. var bn = math.BigNumber(5) >@bn.Gt(3)@ @bn.Gt(10)@ // true false b.Ge(num) b.Ge(BigNumber) Returns bool Determines if a BigNumber is greater than or equal to a number (>=) E.g. var bn = math.BigNumber(5) >@bn.Ge(3)@ @bn.Ge(5)@ // true true b.Lt(num) b.Lt(BigNumber) Returns bool Determines if a BigNumber is less than a number (<) E.g. var bn = math.BigNumber(5) >@bn.Lt(3)@ @bn.Lt(10)@ // false true b.Le(num) b.Le(BigNumber) Returns bool Determines if a BigNumber is less than or equal to a number (<=) E.g. var bn = math.BigNumber(5) >@bn.Le(10)@ @bn.Le(5)@ // true true b.ToString() Returns string Returns a string representation of the BigNumber. Can be used to serialize it for storage. E.g. var myBigNum = math.BigNumber("123456789123456789") storage.Set("myBN", myBigNum.ToString()) --- var bnStr = storage.Get("myBN") var myBigNum = math.BigNumber(bnStr) b.ToUI() Returns string Returns a shortened string representation of the number for use in user interfaces. E.g. var myBigNum = math.BigNumber("123456789123456789") >@myBigNum.ToUI()@ // 123.5Qa color ‾‾‾‾‾ Colors in Stonescript are represented with a string in hexadecimal notation, such as #ff0000 or with simplified presets such as #red. color.FromRGB(r,g,b) Returns string Converts a color from three integer numbers (0 to 255) into a string. E.g. var c = color.FromRGB(255, 0, 128) >`0,0,@c@, @c@ color.ToRGB(string) Returns int[3] Converts a color from string to three integer numbers (0 to 255). E.g. var c = color.Random() var rgb = color.ToRGB(c) var r = rgb［0］ var g = rgb［1］ var b = rgb［2］ >`0,0,@c@, @c@ \n @r@ \n @g@ \n @b@ color.Lerp(c1,c2,t) Returns string Interpolates linearly from color c1 to color c2 at time (percentage) t. E.g. var c1 = "#ff4400" var c2 = "#8888ff" var t = 0.5 var c t = math.sin(time*0.1) / 2 + 0.5 c = color.Lerp(c1, c2, t) >`0,1,@c@,@c@\n ██████ color.Random() Returns string Returns a random color. E.g. var c c = color.Random() >`0,0,@c@,@c@\n ██████ draw ‾‾‾‾ draw.Bg(x, y, color) No return value Sets the background color at a specific screen position. E.g. draw.Bg(5, 4, #red) draw.Bg(x, y, color, w, h) No return value Sets the background color of a rectangular region on screen. E.g. draw.Bg(5, 4, #cyan, 10, 6) draw.Box(x, y, w, h, color, style) No return value Draws a rectangular shape at the specified position and size. The rectangle's border is defined by color and a style number. Negative style numbers cause the center of the rectangle to be transparent. CAVEAT - At this time, advanced prints always draw on top of boxes. Use this example to explore the different styles by pressing Left/Right var style = 1 ?key = leftBegin style-- ?key = rightBegin style++ draw.Box(10, 5, 30, 15, #333333, style) >`12,6,#ffffff,Style = @style@ >`12,8,#888888,Press Left/Right\nto change style draw.Clear() No return value Clears the entire screen. draw.GetSymbol(x, y) Returns string Returns the glyph at screen position (x, y). This example selects a screen coordinate and draws the symbol found there in the top left. The selection [ ] can be moved by the player: var s var x = 20 var y = 10 var drawX ?key=leftBegin x-- ?key=rightBegin x++ ?key=upBegin y-- ?key=downBegin y++ s = draw.GetSymbol(x, y) >`0,1,Symbol = @s@ drawX = x - 1 >`@drawX@,@y@,[#］ draw.Player() No return value Draws the player character, with all equipment and addons, at a specific point in the script. int ‾‾‾ int.Parse(str) Returns integer Converts a string of a number into an integer value. If the given string is not a number an error is thrown. E.g. var s = "999" var i = int.Parse(s) i++ item ‾‾‾‾ item.CanActivate() Returns boolean Returns true if it's possible to activate item abilities. False otherwise. In some gameplay situations all ability activations are disabled, even if they are not on cooldown, such as moments before a boss fight or during a cinematic. E.g. ?item.CanActivate() equip Bardiche activate R item.CanActivate(str) Returns boolean Returns true if it's possible to activate a specific item. Will only ever be true if the item is equipped. Some items can have mechanics that don't allow them to be activated unless specific criteria are met. This is a sub-set of item.GetCooldown(), as an item's cooldown may be zero and it cannot be activated, but it will never be possible t

StoneScript

About

About StoneScript

StoneScript's Area of Expertise

I geek out on...

Chat Starters