diff --git a/docs/classes/dynamicsubviewport.md b/docs/classes/dynamicsubviewport.md new file mode 100644 index 0000000..87025c9 --- /dev/null +++ b/docs/classes/dynamicsubviewport.md @@ -0,0 +1,5 @@ +# DynamicSubViewport +`inherits SubViewport` + +### Usage +This class functions identically to the `SubViewport` class, except it scales automatically to the root viewport. \ No newline at end of file diff --git a/docs/classes/dynamicviewport.md b/docs/classes/dynamicviewport.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/classes/scramblingtext.gif b/docs/classes/scramblingtext.gif new file mode 100644 index 0000000..3eedfe8 Binary files /dev/null and b/docs/classes/scramblingtext.gif differ diff --git a/docs/classes/scramblingtext.md b/docs/classes/scramblingtext.md index e69de29..904eb4e 100644 --- a/docs/classes/scramblingtext.md +++ b/docs/classes/scramblingtext.md @@ -0,0 +1,49 @@ + +# ScramblingText +`inherits Label` + +### Usage +This class implements a 'glitch' effect for a label. +![showcase](scramblingtext.gif) + +### Properties + +| Type | Name | Default | +| ---- | ---- | ------- | +| `String` | chars | `ABCDEFGHIJKLMNOPQRSTUVWXYZ124567890` | +| `Bool` | scrambling | `False` | +| `Float` | speed | `15.0` | +| `Float` | duration | `1.0` | +| `Bool` | infinite | `False` (overridden by editor_hint) | + +`chars` +Stores the character set used for the scramble effect. + +`scrambling` +Whether or not the scrambling effect is active. + +`speed` +How many times per second the text gets scrambled. + +`duration` +How many times to scramble before revealing next character. + +`infinite` +Whether or not the scrambling effect is infinite. + +### Methods +| Returns | Name | +| ------- | ---- | +| `void` | `start()` | +| `void` | `set_text(text: String)` | +| `String` | `get_text()` | + +#### start() +start the scrambling. This acts as a setter function for `scrambling` + +#### set_text(text: String) +Setter for the `text` of the parent class `Label` + +#### get_text() -> String +Getter for the `text` of the parent class `Label` +