Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.64 KB

README.md

File metadata and controls

50 lines (32 loc) · 1.64 KB

The Update Markup

This script enables you to refresh displayed variables whenever they are modified. It is done by wrapping naked variables in two sets of curly brackets : {{$myVar}}.

Thank you to TME for his invaluable code contribution!

Syntax

{[element] [html attributes] {variable}}
<<set $num = 0, $array = ['One','Two','Three','Four','Five']>>

Item at index {{$num}} is {{$array[$num]}} 

<<button 'Next item!'>>
  <<set $num++>>
<</button>>

HTML output

By default, the {{}} macro creates a <span aria-live='polite'>. You can modify the element's type and html attributes by supplying them before the inner set of brackets: {div id='hp' {$hp}} will result in <div id='hp' aria-live='polite'>.

Variable types

This syntax displays any variables that can be fetched by the State.getVar() function. Consequently, namespaces and syntaxes that don't normally work with sugarcube's naked variables markup can be used. {{$player.hp}},{{setup.myObject['someKey']}} or {{window.globalVariable}} are all valid.

Input-less updating

The script updates wrappers based on 4 events : change click drop keyup, which make up for the vast majority of variable changes.

Still, you might want to cause such update programmatically by calling the setup.updateWrappers() function.

<<set $time = 0>>

Time passes.
You have been there for {{$time}} second{{$time !== 1? 's' : ''}}.

<<silently>>
  <<repeat 1s>>
    <<set $time++, setup.updateWrappers()>>
  <</repeat>>
<</silently>>