(5.5.0) __scribble_config - JujuAdams/ScribbleOldDocs GitHub Wiki

__scribble_config()

Returns: N/A (0)

Argument	Name	Purpose
None

This script holds a number of macros that customise the behaviour of Scribble. __scribble_config() never needs to be directly called in code, but the script and the macros it contains must be present in a project for Scribble to work.

Macro	Typical value	Purpose
*General*
`SCRIBBLE_HASH_NEWLINE`	`true`	Replaces hashes (#) with newlines (ASCII chr10) to emulate GMS1's newline behaviour
`SCRIBBLE_COLOURISE_SPRITES`	`true`	Whether to apply the text colour to non-animated sprites (animated sprites are always blended white)
`SCRIBBLE_VERBOSE`	`false`	Enables verbose console output to aid with debugging
`SCRIBBLE_ADD_SPRITE_ORIGINS`	`false`	Whether to use sprite origins. Setting this to `false` will vertically centre sprites on each line of text
`SCRIBBLE_SPRITEFONT_ALIGN_GLYPHS_LEFT`	`false`	Controls how Scribble chooses to align spritefonts. Set this to `true` to copy GameMaker, removing all space to the left of each glyph
`SCRIBBLE_DEFAULT_DELAY_DURATION`	`450`	Default pause length of the `[delay]` command in milliseconds
*Starting Format*
`SCRIBBLE_DEFAULT_TEXT_COLOUR`	`c_white`	Default (vertex) colour of text
`SCRIBBLE_DEFAULT_HALIGN`	`fa_left`
`SCRIBBLE_DEFAULT_SPRITE_SPEED`	`0.1`	Default animation speed for sprites inserted into text, in frames per step
*Box Alignment*
`SCRIBBLE_DEFAULT_BOX_HALIGN`	`fa_left`	Default alignment of the textbox. `fa_left` places the left-hand side of the box at the draw coordinate when using `scribble_draw()`
`SCRIBBLE_DEFAULT_BOX_VALIGN`	`fa_top`	Default alignment of the textbox. `fa_top` places the top of the box at the draw coordinate when using `scribble_draw()`
*Text Wrapping*
`SCRIBBLE_DEFAULT_LINE_MIN_HEIGHT`	`-1`	Default minimum height of each line of text. Set to a negative value to use the height of a space character of the default font
`SCRIBBLE_DEFAULT_MAX_WIDTH`	`-1`	Default maximum horizontal size of the textbox. Set to a negative value for no limit
`SCRIBBLE_DEFAULT_MAX_HEIGHT`	`-1`	Default maximum vertical size of the textbox. Set to a negative value for no limit
*Transform*
`SCRIBBLE_DEFAULT_XSCALE`	`1.0`	Default x scale of the textbox
`SCRIBBLE_DEFAULT_YSCALE`	`1.0`	Default y scale of the textbox
`SCRIBBLE_DEFAULT_ANGLE`	`0.0`	Default rotation of the textbox
*Color Blending*
`SCRIBBLE_DEFAULT_BLEND_COLOUR`	`c_white`	Default blend colour
`SCRIBBLE_DEFAULT_BLEND_ALPHA`	`1.0`	Default alpha