(6.0.0) Changes From v5.x.x - JujuAdams/ScribbleOldDocs GitHub Wiki

1. The majority of the default draw state macros have been removed. Please configure the default draw state in scribble_reset()
2. The SCRIBBLE_MAX_EFFECTS and SCRIBBLE_MAX_DATA_FIELDS macros have been removed
3. Deprecated scribble_draw_set_cache_group() - Please use scribble_cache()
4. Deprecated scribble_get_quad() - Please use scribble_get_bbox()
5. Renamed scribble_cache_group_flush() - Please use scribble_flush()
6. Renamed scribble_autotype_add_event() to scribble_add_autotype_event()
7. The main __SCRIBBLE enum has been renamed to SCRIBBLE
8. Renamed SCRIBBLE_STATE.HALIGN and SCRIBBLE_STATE.VALIGN to SCRIBBLE_STATE.BOX_HALIGN and SCRIBBLE_STATE.BOX_VALIGN
9. Added macro SCRIBBLE_BGR_COLOR_HEX_CODES to set the in-line colour hex code format to [#BBGGRR] if so desired
10. Fixed incorrect values being calculated by fade() in shd_scribble
11. Deprecates scribble_draw_set_*() functions for scribble_set_*() to make it clearer that these functions affect scribble_cache() and scribble_get_bbox() as well as scribble_draw()
12. Added decimal colour decoding by using a [d#<value>] tag. The decimal value is the same as a native GameMaker colour constant - a 24-bit integer in #BBGGRR format
13. Removed named cache groups. They were clumsy and hard to understand! scribble_flush() now either accepts the keyword all which will flush all text elements (also the default behaviour), or a single text element
14. Added scribble_add_autotype_character_delay() to automatically create autotype [delay] commands after the given character. There is no limit to how many character delays you set up, though character delays are global
15. Lots of functions can now take either a string or a text element as a parameter
16. Removes texel width/height uniforms from the default shader
17. Adds scribble_get_width() and scribble_get_height()
18. Renames __scribble_config() to __scribble_macros()
19. Changes arguments for scribble_autotype_fade_in() and scribble_autotype_fade_out()
20. Spritefonts can now be monospaced or non-proportional

Issues addressed:

#19 - Sprites can now be whitelisted using scribble_whitelist_sprite(). If no sprites are whitelisted, all sprites are permitted

#27 - Splits scribble_draw_set_wrap() into scribble_set_wrap() and scribble_set_line_height(). scribble_set_wrap() now sets the maximum width/height of the textbox whereas scribble_set_line_height() controls the minimum/maximum line height

#30 - scribble_add_font() now accepts an extra optional argument [texture] that allows a specific texture to be used for a font

#31 - scribble_bake_outline() is available. This function creates a new copy of the target font including an outline

#34 - Autoscan now works cross-platform

#35 - scribble_autotype_set_sound() now uses a min/max pitch value

#36 - scribble_draw_set_fade() has finally been deprecated! Please use the scribble_autotype_* functions

#40 - SCRIBBLE_MISSING_CHARACTER can now be used to specify a character to use when a character in a string is missing in a font

#57 & #60 - fa_left / fa_center / fa_right now behave like GameMaker's native draw_set_halign(). Existing alignment functionality in Scribble can be achieved using the new formatting tags pin_left / pin_center / pin_right

#59 - Argument order for scribble_get_bbox() now matches scribble_draw()

#61 - Added scribble_set_starting_format() so you can set the default font/colour/alignment during operation

#62 - scribble_set_box_align() now accepts -1 as a non-setting value

#63 - An array of character codes can be generated by setting macro SCRIBBLE_CREATE_CHRACTER_ARRAY to true. Bear in mind there is a performance penalty for doing so!

#64 - Adds scribble_autotype_set_sound_per_char() and scribble_autotype_function()

#65 - The cache string now includes the character wrapping state

#68 - Fixed page start/end character indexes e.g. for use with SCRIBBLE_CREATE_CHARACTER_ARRAY

#69 - Added "occurance" feature that allows for different hosts (usually different instances) to display the same underlying text element with different autotype states

#71 - Line height now correct when the last word in a string wraps to a new line

#73 - Fixed events not firing if they're right at the end of the string