diff --git a/SVUI_!Core/guide/_template/config.ld b/SVUI_!Core/guide/_template/config.ld index 8802775..1bf3a1e 100644 --- a/SVUI_!Core/guide/_template/config.ld +++ b/SVUI_!Core/guide/_template/config.ld @@ -6,13 +6,28 @@ format='discount' backtick_references=false file = { '../../system/core.lua', - '../../libs/_Librarian', - '../../libs/_SVUI_Lib', - '../../libs/AceVillain-1.0/AceVillain-1.0.lua' + '../../libs/_Librarian/Librarian.lua', + '../../libs/_SVUI_Lib/LUA.lua', + '../../libs/_SVUI_Lib/Registry.lua', + '../../libs/_SVUI_Lib/Linguist.lua', + '../../libs/_SVUI_Lib/Events.lua', + '../../libs/_SVUI_Lib/Timers.lua', + '../../libs/_SVUI_Lib/Animate.lua', + '../../libs/_SVUI_Lib/SpecialFX.lua', + '../../libs/_SVUI_Lib/Sounds.lua', + '../../libs/AceVillain-1.0/AceVillain-1.0.lua', + '../../system/media.lua' } dir='../docs' readme='doc.md' style=true template=true not_luadoc=true -kind_names={topic='Manual',classmod='Packages',script='Scripts',module='Addon',file='Libraries'} +all=true +kind_names={topic='Manual',module='Addons',file='Libraries',classmod='Packages'} +custom_tags={ + {'media',title='Media'}, + {'plugin',title='Plugins'}, + {'lang',title='Localization'}, + {'userdata',title='User Data'} +} diff --git a/SVUI_!Core/guide/_template/ldoc.css b/SVUI_!Core/guide/_template/ldoc.css index cdfa9c4..2a8d337 100644 --- a/SVUI_!Core/guide/_template/ldoc.css +++ b/SVUI_!Core/guide/_template/ldoc.css @@ -6,4 +6,4 @@ /*** * Custom Styles for the SVUI Site. */ -body,html{height:100%;background-color:#333}td,tr{height:auto!important}body{text-shadow:0 1px 3px rgba(0,0,0,.12);font-family:Roboto,"Helvetica Neue",Helvetica,Arial,sans-serif}h1,h2,h3,h4,h5,h6{margin:0;font-size:18px;text-transform:uppercase;letter-spacing:1px;color:#000;text-shadow:1px 1px 4px #888}table{border-collapse:collapse}tr{min-height:28px}p{margin:0;padding:12px 20px;line-height:20px;font-size:15px}a{color:#07F;text-shadow:1px 1px 2px #ccc,-1px -1px 1px #fff;background-color:transparent;transition:all .2s ease-in-out}a:focus,a:hover{text-decoration:none;color:#0C0;text-shadow:0 0 1px #fff,0 0 1px #fff}.button-icon{text-transform:none;transition:all .3s ease-in-out;color:#1FCCFF;padding:12px 16px;font-size:28px;line-height:1.33;border-radius:50px}.button-icon,.button-icon:focus,.button-icon:hover{border:1px solid transparent;background-color:transparent}.button-icon:focus,.button-icon:hover{outline:0;color:#FF0}.current-link{background-color:rgba(0,255,0,.2)}.layout-title{text-transform:uppercase;letter-spacing:1px;color:#FF6F00;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #000}.layout-drawer{color:#fff;text-shadow:0 1px 3px rgba(0,0,0,.5);background-color:#3F3F3F;border-right:1px solid #000}.navigation-link{padding:2px 40px!important;color:#fff!important;text-shadow:1px 1px 2px #000!important}.navigation-link:focus,.navigation-link:hover{text-decoration:none;color:#0C0;text-shadow:1px 1px 2px #000!important}.navigation-link .material-icons{font-size:24px;margin-right:32px}.navigation-subtitle,.navigation-title{display:block;position:relative;border-bottom:1px solid rgba(0,0,0,.3);font-size:20px;line-height:1;letter-spacing:.02em;font-weight:400;box-sizing:border-box}.navigation-title{color:#888;padding:2px 8px 8px}.navigation-subtitle{padding:8px 16px 4px!important;color:#FF0;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #000}.navigation-spacer{padding:1px 0;border-bottom:1px solid rgba(100,100,100,.2);-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1}.container-title{letter-spacing:0;color:#FF6F00;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #C50}.container-subtitle{font-size:14px;letter-spacing:0;color:#FF0;text-shadow:-.1em .18em .14em #B30,-.08em .1em .08em #C40,-.22em .35em .1em #000,.18em -.1em .2em #000}.card-header-title{text-transform:uppercase;font-size:26px;color:#1FCCFF;text-shadow:1px 3px 1px #000,0 3px 20px #04C;letter-spacing:0}.card-header-subtitle{color:#000;text-shadow:0 0 3px #999}.section-actions,.section-dialog{background-color:#fff!important} +body,html{height:100%;background-color:#333}td,tr{height:auto!important}body{text-shadow:0 1px 3px rgba(0,0,0,.12);font-family:Roboto,"Helvetica Neue",Helvetica,Arial,sans-serif}h1,h2,h3,h4,h5,h6{margin:0;text-transform:uppercase;letter-spacing:1px;font-weight:500;color:#000;text-shadow:1px 1px 4px #888}h1{font-size:24px}h2{font-size:22px}h3{font-size:20px}h4{font-size:18px}h5{font-size:16px}h6{font-size:14px}small{font-size:.8em!important}small:before{content:"\00a0\00a0//\00a0\00a0";display:inline-block}small:after{content:" ";clear:both}table{border-collapse:collapse}tr{min-height:28px}p{margin:0;padding:12px 20px;line-height:20px;font-size:15px}a{color:#07F;text-shadow:1px 1px 2px #ccc,-1px -1px 1px #fff;background-color:transparent;transition:all .2s ease-in-out}a:focus,a:hover{text-decoration:none;color:#0C0;text-shadow:0 0 1px #fff,0 0 1px #fff}.section-label{display:inline-block;padding:4px 12px;border-radius:50px;margin-left:-12px;line-height:1!important;border:2px solid rgba(0,0,0,.12)}h1.section-label,h2.section-label,h3.section-label{background-color:rgba(255,75,0,.4)}h4.section-label{background-color:rgba(255,255,0,.4)}h5.section-label{background-color:rgba(75,255,0,.4)}h6.section-label{background-color:rgba(0,200,255,.4)}.button-icon{text-transform:none;transition:all .3s ease-in-out;color:#1FCCFF;padding:12px 16px;font-size:28px;line-height:1.33;border-radius:50px}.button-icon,.button-icon:focus,.button-icon:hover{border:1px solid transparent;background-color:transparent}.card-header-title,.layout-title,.navigation-link{text-transform:uppercase}.button-icon:focus,.button-icon:hover{outline:0;color:#FF0}.current-link{background-color:rgba(0,255,0,.2)}.layout-title{letter-spacing:1px;color:#FF6F00;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #000}.layout-drawer{color:#fff;text-shadow:0 1px 3px rgba(0,0,0,.5);background-color:#3F3F3F;border-right:1px solid #000}.navigation-link{padding:2px 40px!important;color:#fff!important;text-shadow:1px 1px 2px #000!important}.navigation-link:focus,.navigation-link:hover{text-decoration:none;color:#0C0;text-shadow:1px 1px 2px #000!important}.navigation-link .material-icons{font-size:24px;margin-right:32px}.navigation-subtitle,.navigation-title{display:block;position:relative;border-bottom:1px solid rgba(0,0,0,.3);font-size:20px;line-height:1;letter-spacing:.02em;font-weight:400;box-sizing:border-box}.navigation-title{color:#888;padding:2px 8px 8px}.navigation-subtitle{padding:8px 16px 4px!important;color:#FF0;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #000}.navigation-spacer{padding:1px 0;border-bottom:1px solid rgba(100,100,100,.2);-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1}.container-title{letter-spacing:0;color:#FF6F00;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #C50}.container-subtitle{font-size:14px;letter-spacing:0;color:#FF0;text-shadow:-.1em .18em .14em #B30,-.08em .1em .08em #C40,-.22em .35em .1em #000,.18em -.1em .2em #000}.card-header{padding:0!important}.card-header-title{font-size:26px;color:#1FCCFF;text-shadow:1px 3px 1px #000,0 3px 20px #04C;letter-spacing:0}.card-header-subtitle{color:#000;text-shadow:0 0 3px #999}.section-actions,.section-dialog{background-color:#fff!important} diff --git a/SVUI_!Core/guide/_template/ldoc.ltp b/SVUI_!Core/guide/_template/ldoc.ltp index d8df24e..5d76a5c 100644 --- a/SVUI_!Core/guide/_template/ldoc.ltp +++ b/SVUI_!Core/guide/_template/ldoc.ltp @@ -7,10 +7,6 @@ <link rel="stylesheet" href="$(ldoc.css)" type="text/css" /> <!-- Fonts --> <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> </head> <body id="page-top" data-spy="scroll" data-target=".layout-header"> <div class="skinned-page"></div> @@ -47,20 +43,20 @@ # if ldoc.no_summary and module and not ldoc.one then -- bang out the functions on the side # for kind, items in module.kinds() do <div class="navigation-subtitle">$(kind)</div> - # for item in items() do - <a href="#$(item.name)" class="navigation-link">$(display_name(item))</a> - # end - <div class="navigation-spacer"></div> +# for item in items() do +<a href="#$(item.name)" class="navigation-link">$(display_name(item))</a> +# end +<div class="navigation-spacer"></div> # end # end # -------- contents of project ---------- # local this_mod = module and module.name # for kind, mods, type in ldoc.kinds() do # if ldoc.allowed_in_contents(type,module) then - <div class="navigation-subtitle">$(kind)</div> +<div class="navigation-subtitle">$(kind)</div> # for mod in mods() do local name = display_name(mod) # if mod.name == this_mod then - <a href="$(ldoc.ref_to_module(mod))" class="navigation-link current-link">$(name)</a> +<a href="$(ldoc.ref_to_module(mod))" class="navigation-link current-link">$(name)</a> # --------- contents of module ------------- # if module and not ldoc.no_summary and #module.items > 0 then # for kind,items in module.kinds() do @@ -115,37 +111,28 @@ </div> <div class="card-section"> <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - $(M(module.description,module)) - </p> + <h4 class="section-label">Info:</h4> + <ul> + <li>$(M(module.description,module))</li> # if module.tags.include then - $(M(ldoc.include_file(module.tags.include))) + <li>$(M(ldoc.include_file(module.tags.include)))</li> # end -# if module.usage then -# local li,il = use_li(module.usage) - <h5 class="info-header">Usage:</h5> - <p class="preface"> - <ul> -# for usage in iter(module.usage) do - $(li)<pre class="example">$(ldoc.escape(usage))</pre>$(il) -# end -- for - </ul> - </p> -# end -- if usage # if module.info then - <h5 class="info-header">Info:</h5> - <p class="preface"> - <ul> # for tag, value in module.info:iter() do <li><strong>$(tag)</strong>: $(M(value,module))</li> # end - </ul> - </p> + <hr /> # end -- if module.info + </ul> +# if module.usage then + <h5 class="section-label">Construct:</h5> +# for usage in iter(module.usage) do + <pre class="example">$(ldoc.prettify(usage))</pre> +# end -- for + <hr /> +# end -- if usage # if not ldoc.no_summary then -<h5 class="info-header">Summary:</h5> -<p class="preface"> + <h5 class="section-label">Summary:</h5> # for kind,items in module.kinds() do <div style="padding:6px 0px;"><a href="#$(no_spaces(kind))" style="color:#ff5500">Jump To: $(kind)⋙</a></div> <table class="function_list"> @@ -157,7 +144,7 @@ # end -- for items </table> # end -- for kinds -</p> + <hr /> # end -- if not no_summary <br /> <br /> @@ -168,18 +155,21 @@ # for kind, items in module.kinds() do # local kitem = module.kinds:get_item(kind) # local has_description = kitem and ldoc.descript(kitem) ~= "" - <h4 class="section-header $(has_description and 'has-description')"><a name="$(no_spaces(kind))"></a>$(kind)</h4> + <h6 class="section-label" id="$(no_spaces(kind))">$(kind) $(M(module.kinds:get_section_description(kind),nil)) # if kitem then # if has_description then - <div class="section-description"> + <small> $(M(ldoc.descript(kitem),kitem)) - </div> + </small> # end + </h6> # if kitem.usage then <h5>Usage:</h5> <pre class="example">$(ldoc.prettify(kitem.usage[1]))</pre> # end +# else + </h6> # end <dl class="function"> # for item in items() do @@ -196,7 +186,6 @@ # for custom in iter(ldoc.custom_tags) do # local tag = item.tags[custom[1]] # if tag and not custom.hidden then -# local li,il = use_li(tag) <table> <thead> <tr><th><strong>$(custom.title or custom[1]):</strong></th></tr> @@ -329,7 +318,7 @@ <div class="section-dialog"> # for kind, mods in ldoc.kinds() do - <h4>$(kind)</h4> + <h6>$(kind)</h6> # kind = kind:lower() <table class="module_list"> # for m in mods() do diff --git a/SVUI_!Core/guide/_template/svui.css b/SVUI_!Core/guide/_template/svui.css index 4086c96..36af91d 100644 --- a/SVUI_!Core/guide/_template/svui.css +++ b/SVUI_!Core/guide/_template/svui.css @@ -13,12 +13,41 @@ body { h1, h2, h3, h4, h5, h6 { margin: 0; - font-size: 18px; text-transform: uppercase; letter-spacing: 1px; + font-weight: 500; color: #000; text-shadow: 1px 1px 4px #888; } +h1 { + font-size: 24px; } + +h2 { + font-size: 22px; } + +h3 { + font-size: 20px; } + +h4 { + font-size: 18px; } + +h5 { + font-size: 16px; } + +h6 { + font-size: 14px; } + +small { + font-size: 0.8em !important; } + +small:before { + content: "\00a0\00a0//\00a0\00a0"; + display: inline-block; } + +small:after { + content: " "; + clear: both; } + table { border-collapse: collapse; } @@ -46,6 +75,29 @@ a:hover, a:focus { color: #0C0; text-shadow: 0px 0px 1px #fff,0px 0px 1px #fff; } +.section-label{ + display: inline-block; + padding: 4px 12px; + border-radius: 50px; + margin-left: -12px; + line-height: 1 !important; + border: 2px solid rgba(0,0,0,0.12); +} + +h1.section-label, +h2.section-label, +h3.section-label { + background-color: rgba(255,75,0,0.4); } + +h4.section-label { + background-color: rgba(255,255,0,0.4); } + +h5.section-label { + background-color: rgba(75,255,0,0.4); } + +h6.section-label { + background-color: rgba(0,200,255,0.4); } + .button-icon { text-transform: none; transition: all 0.3s ease-in-out; @@ -80,6 +132,7 @@ a:hover, a:focus { border-right: 1px solid #000; } .navigation-link { + text-transform: uppercase; padding: 2px 40px !important; color: #fff !important; text-shadow: 1px 1px 2px #000 !important; } @@ -139,6 +192,10 @@ a:hover, a:focus { color: #FFFF00; text-shadow: -0.1em 0.18em 0.14em #B30, -0.08em 0.1em 0.08em #C40, -0.22em 0.35em 0.1em #000, 0.18em -0.1em 0.2em #000; } +.card-header{ + padding:0 !important; +} + .card-header-title { text-transform: uppercase; font-size: 26px; diff --git a/SVUI_!Core/guide/docs/addon/SVUI.html b/SVUI_!Core/guide/docs/addon/SVUI.html deleted file mode 100644 index 15ba67c..0000000 --- a/SVUI_!Core/guide/docs/addon/SVUI.html +++ /dev/null @@ -1,123 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SVUI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> - <!-- Fonts --> - <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> -</head> -<body id="page-top" data-spy="scroll" data-target=".layout-header"> -<div class="skinned-page"></div> -<div id="message-depot"></div> -<!-- BEGIN LAYOUT --> -<div class="layout js-layout js-skins layout-overlay-drawer-button layout-shadow layout-fixed-header layout-fixed-drawer"> - - -<!-- BEGIN NAV // --> - <div class="layout-header"> - <div class="layout-header-row"> - <span class="layout-title">Documentation</span> - <div class="layout-spacer"></div> - <nav class="navigation"> - </nav> - </div> - </div> - - <div class="layout-drawer"> - <span class="navigation-title" style="padding:">Contents</span> - <nav class="navigation" style="padding-top:0 !important;"> - <div class="navigation-subtitle">Addon</div> - <a href="../index.html" class="navigation-link current-link">SVUI</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Manual</div> - <a href="../manual/doc.md.html" class="navigation-link">doc</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Libraries</div> - <a href="../libraries/Librarian.html" class="navigation-link">Librarian</a> - <a href="../libraries/LUA.html" class="navigation-link">LUA</a> - <a href="../libraries/AceVillain.html" class="navigation-link">AceVillain</a> - <div class="navigation-spacer"></div> - </nav> - </div> - - <span class="layout-title floating-title no-desktop">Menu</span> - - <div class="layout-drawer-button"> - <i class="layout-drawer-button-icon menu-icon"></i> - </div> - <!-- END NAV // --> - - <!-- BEGIN CONTENT // --> - <div class="layout-content"> - -<section style="padding:0;"> -<div class="grid"> -<div class="cell cell-12-col"> -<div class="container"> - <div class="comic"> - <div class="card"> - <div class="card-header flex--expand"> - <div class="card-header-title flex--centered"> - <span class="badge" data-badge="Module">SVUI</span> - </div> - </div> - <div class="card-actions flex--expand"> - <div class="card-header-subtitle flex--centered">SVUI is our global addon object.</div> - </div> - <div class="card-section"> - <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - SuperVillain UI Core Module. - </p> - <h5 class="info-header">Info:</h5> - <p class="preface"> - <ul> - <li><strong>Release</strong>: 1.0.0</li> - <li><strong>Author</strong>: Steven Jackson (2014)</li> - </ul> - </p> -<h5 class="info-header">Summary:</h5> -<p class="preface"> -</p> - <br /> - <br /> - </div> - </div> - </div> - </div> -</div> -</div> -</div> -</section> -</div> -<!-- END CONTENT --> - -<!-- BEGIN FOOTER // --> -<footer> - <div class="right-section"> - <ul class="link-list"> - <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:32:23</span> - </li> - </ul> - </div> -</footer> -<!-- END FOOTER // --> - -</div> -<!-- END LAYOUT --> - -<!-- Core JavaScript --> -<script src="http://supervillainui.com/js/app.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery-1.11.0.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.easing.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.swipebox.min.js"></script> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/addons/SVUI_Core.html b/SVUI_!Core/guide/docs/addons/SVUI_Core.html new file mode 100644 index 0000000..b23a4b0 --- /dev/null +++ b/SVUI_!Core/guide/docs/addons/SVUI_Core.html @@ -0,0 +1,688 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> +<head> + <title>SVUI Guide</title> + <link rel="stylesheet" href="../ldoc.css" type="text/css" /> + <!-- Fonts --> + <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> +</head> +<body id="page-top" data-spy="scroll" data-target=".layout-header"> +<div class="skinned-page"></div> +<div id="message-depot"></div> +<!-- BEGIN LAYOUT --> +<div class="layout js-layout js-skins layout-overlay-drawer-button layout-shadow layout-fixed-header layout-fixed-drawer"> + + +<!-- BEGIN NAV // --> + <div class="layout-header"> + <div class="layout-header-row"> + <span class="layout-title">Documentation</span> + <div class="layout-spacer"></div> + <nav class="navigation"> + </nav> + </div> + </div> + + <div class="layout-drawer"> + <span class="navigation-title" style="padding:">Contents</span> + <nav class="navigation" style="padding-top:0 !important;"> +<div class="navigation-subtitle">Addons</div> +<a href="../index.html" class="navigation-link current-link">SVUI_Core</a> +<a href="#Messages" class="navigation-link"> Messages </a> +<a href="#Utilities" class="navigation-link"> Utilities </a> +<a href="#media_Functions" class="navigation-link"> media Functions</a> +<div class="navigation-spacer"></div> + <div class="navigation-spacer"></div> +<div class="navigation-subtitle">Manual</div> + <a href="../manual/doc.md.html" class="navigation-link">doc</a> + <div class="navigation-spacer"></div> +<div class="navigation-subtitle">Libraries</div> + <a href="../libraries/Librarian.html" class="navigation-link">Librarian</a> + <a href="../libraries/LUA.html" class="navigation-link">LUA</a> + <a href="../libraries/AceVillain.html" class="navigation-link">AceVillain</a> + <div class="navigation-spacer"></div> + </nav> + </div> + + <span class="layout-title floating-title no-desktop">Menu</span> + + <div class="layout-drawer-button"> + <i class="layout-drawer-button-icon menu-icon"></i> + </div> + <!-- END NAV // --> + + <!-- BEGIN CONTENT // --> + <div class="layout-content"> + +<section style="padding:0;"> +<div class="grid"> +<div class="cell cell-12-col"> +<div class="container"> + <div class="comic"> + <div class="card"> + <div class="card-header flex--expand"> + <div class="card-header-title flex--centered"> + <span class="badge" data-badge="Module">SVUI_Core</span> + </div> + </div> + <div class="card-actions flex--expand"> + <div class="card-header-subtitle flex--centered">SVUI is our global addon object.</div> + </div> + <div class="card-section"> + <div class="section-dialog"> + <h4 class="section-label">Info:</h4> + <ul> + <li> SuperVillain UI Core Module.</li> + <li><strong>Release</strong>: 1.0.0</li> + <li><strong>Author</strong>: Steven Jackson (2014)</li> + <hr /> + </ul> + <h5 class="section-label">Construct:</h5> + <pre class="example"> + <span class="comment">-- Every other file will set a reference to the addon using this variable. Here is how we set it. +</span> + <span class="comment">-- METHOD 1 ---------------------------------------------------------------- +</span> <span class="comment">-- if we are setting this inside the core.lua file then use this method +</span> <span class="keyword">local</span> global = <span class="string">"SVUI_Global"</span> <span class="comment">-- reference to SavedVariables +</span> <span class="keyword">local</span> errors = <span class="string">"SVUI_Errors"</span> <span class="comment">-- reference to SavedVariables +</span> <span class="keyword">local</span> private = <span class="string">"SVUI_Private"</span> <span class="comment">-- reference to SavedVariables +</span> <span class="keyword">local</span> media = <span class="string">"SVUI_Media"</span> <span class="comment">-- reference to SavedVariables +</span> <span class="keyword">local</span> shared = <span class="string">"SVUI_Shared"</span> <span class="comment">-- reference to SavedVariables +</span> + <span class="keyword">local</span> Registry = Librarian(<span class="string">"Registry"</span>) <span class="comment">-- now pull down the Registry object +</span> <span class="comment">-- finally we use the 'NewCore' function specifically for this +</span> <span class="keyword">local</span> SV = Registry:NewCore(global, errors, private, media, shared) + + <span class="comment">-- METHOD 2 ---------------------------------------------------------------- +</span> <span class="comment">-- if we are setting the variable in any other file then use this method +</span> <span class="keyword">local</span> SV = _G[<span class="string">'SVUI'</span>]</pre> + <hr /> + <h5 class="section-label">Summary:</h5> + <div style="padding:6px 0px;"><a href="#Messages" style="color:#ff5500">Jump To: Messages ⋙</a></div> + <table class="function_list"> + <tr> + <td class="name" nowrap><a href="#SCTMessage">SCTMessage (message, red, green, blue, displayType)</a></td> + <td class="summary">Send messages to the scrolling message frame (combat text).</td> + </tr> + <tr> + <td class="name" nowrap><a href="#AddonMessage">AddonMessage (message)</a></td> + <td class="summary">Send messages to the chat frame prefixed with the addon branding.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#CharacterMessage">CharacterMessage (message)</a></td> + <td class="summary">Send messages to the chat frame as if they came from your character.</td> + </tr> + </table> + <div style="padding:6px 0px;"><a href="#Utilities" style="color:#ff5500">Jump To: Utilities ⋙</a></div> + <table class="function_list"> + <tr> + <td class="name" nowrap><a href="#fubar">fubar ()</a></td> + <td class="summary">Dummy function used to override existing methods, effectively killing them.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#StaticPopup_Show">StaticPopup_Show (arg)</a></td> + <td class="summary">Request specific ‘Static Popup’ windows.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#ResetAllUI">ResetAllUI ()</a></td> + <td class="summary">Reset all SVUI created settings to defaults.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#ResetUI">ResetUI ()</a></td> + <td class="summary">Reset layout positions back to their default.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#ToggleConfig">ToggleConfig ()</a></td> + <td class="summary">Open the config menu (‘/sv’).</td> + </tr> + <tr> + <td class="name" nowrap><a href="#VersionCheck">VersionCheck ()</a></td> + <td class="summary">Checks to see which (if any) version of the core that the client has installed.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#RefreshEverything">RefreshEverything ()</a></td> + <td class="summary">Reloads all current packages and modules.</td> + </tr> + </table> + <div style="padding:6px 0px;"><a href="#media_Functions" style="color:#ff5500">Jump To: media Functions⋙</a></div> + <table class="function_list"> + <tr> + <td class="name" nowrap><a href="#ColorGradient">ColorGradient (percentage, ...)</a></td> + <td class="summary">Returns a color value based on percentages.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#HexColor">HexColor (red, green, blue)</a></td> + <td class="summary">Returns a hexadecimal color value.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#FontManager">FontManager (obj, template, abstract, sizeMod, styleOverride, red, green, blue)</a></td> + <td class="summary">Adds a font object to the custom SVUI font manager.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#GenerateFontOptionGroup">GenerateFontOptionGroup (groupName, groupCount, groupOverview, groupList)</a></td> + <td class="summary">Create an add-in set of specific font configuration options.</td> + </tr> + </table> + <hr /> + <br /> + <br /> + <h6 class="section-label" id="Messages">Messages + + <small> + Addon Message Handlers + </small> + </h6> + <dl class="function"> + <dt id="SCTMessage"> + <strong>SCTMessage (message, red, green, blue, displayType)</strong> + </dt> + <dd> + Send messages to the scrolling message frame (combat text). + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>message</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + The dialog to be displayed. + </td></tr> + <tr><td style="width:20% !important;"><strong>red</strong><td> + Text coloring, red value. + </td></tr> + <tr><td style="width:20% !important;"><strong>green</strong><td> + Text coloring, green value. + </td></tr> + <tr><td style="width:20% !important;"><strong>blue</strong><td> + Text coloring, blue value. + </td></tr> + <tr><td style="width:20% !important;"><strong>displayType</strong><td> + Special animation type (STICKY, CRITICAL or nil). + </td></tr> +</tbody></table> + + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example">SV:SCTMessage(<span class="string">'My message'</span>, <span class="number">0.1</span>, <span class="number">0.2</span>, <span class="number">0.3</span>, <span class="string">'STICKY'</span>)</pre> + </ul> + + </dd> + <dt id="AddonMessage"> + <strong>AddonMessage (message)</strong> + </dt> + <dd> + Send messages to the chat frame prefixed with the addon branding. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>message</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + The dialog to be displayed. + </td></tr> +</tbody></table> + + + + + + </dd> + <dt id="CharacterMessage"> + <strong>CharacterMessage (message)</strong> + </dt> + <dd> + Send messages to the chat frame as if they came from your character. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>message</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + The dialog to be displayed. + </td></tr> +</tbody></table> + + + + + + </dd> + </dl> + <h6 class="section-label" id="Utilities">Utilities + + <small> + Utilities used and shared by the SVUI core. + </small> + </h6> + <dl class="function"> + <dt id="fubar"> + <strong>fubar ()</strong> + </dt> + <dd> + Dummy function used to override existing methods, effectively killing them. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> + <ol> + + nothing. + </ol> + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example"> + <span class="comment">-- Kill a function +</span> SomeObject.some_function = SV.fubar</pre> + </ul> + + </dd> + <dt id="StaticPopup_Show"> + <strong>StaticPopup_Show (arg)</strong> + </dt> + <dd> + Request specific ‘Static Popup’ windows. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>arg</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + Name of the popup + </td></tr> +</tbody></table> + + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example"> + <span class="comment">-- Open the 'Reload UI' popup +</span> SV:StaticPopup_Show(<span class="string">'RL_CLIENT'</span>)</pre> + </ul> + + </dd> + <dt id="ResetAllUI"> + <strong>ResetAllUI ()</strong> + </dt> + <dd> + Reset all SVUI created settings to defaults. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + + + + + + </dd> + <dt id="ResetUI"> + <strong>ResetUI ()</strong> + </dt> + <dd> + Reset layout positions back to their default. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + + + + + + </dd> + <dt id="ToggleConfig"> + <strong>ToggleConfig ()</strong> + </dt> + <dd> + Open the config menu (‘/sv’). + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + + + + + + </dd> + <dt id="VersionCheck"> + <strong>VersionCheck ()</strong> + </dt> + <dd> + Checks to see which (if any) version of the core that the client has installed. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + + + + + + </dd> + <dt id="RefreshEverything"> + <strong>RefreshEverything ()</strong> + </dt> + <dd> + Reloads all current packages and modules. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + + + + + + </dd> + </dl> + <h6 class="section-label" id="media_Functions">media Functions + + </h6> + <dl class="function"> + <dt id="ColorGradient"> + <strong>ColorGradient (percentage, ...)</strong> + </dt> + <dd> + Returns a color value based on percentages. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>percentage</strong><td> + <span class="types"><span class="type">number</span></span> + The needed gradient percent. + </td></tr> + <tr><td style="width:20% !important;"><strong>...</strong><td> + (vararg) remaining arguments are up to 3 sets of numeric color values (r,g,b). + </td></tr> +</tbody></table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> + <ol> + + red value, green value, blue value + </ol> + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example">SV:ColorGradient(<span class="number">50</span>,<span class="number">1</span>,<span class="number">0</span>,<span class="number">0</span>,<span class="number">1</span>,<span class="number">1</span>,<span class="number">0</span>,<span class="number">0</span>,<span class="number">1</span>,<span class="number">0</span>)</pre> + </ul> + + </dd> + <dt id="HexColor"> + <strong>HexColor (red, green, blue)</strong> + </dt> + <dd> + Returns a hexadecimal color value. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>red</strong><td> + <span class="types"><span class="type">number</span></span> + Color, red value. + </td></tr> + <tr><td style="width:20% !important;"><strong>green</strong><td> + <span class="types"><span class="type">number</span></span> + Color, green value. + </td></tr> + <tr><td style="width:20% !important;"><strong>blue</strong><td> + <span class="types"><span class="type">number</span></span> + Color, blue value. + </td></tr> +</tbody></table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> + <ol> + + Hexadecimal string color + </ol> + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example">SV:HexColor(<span class="number">0.1</span>, <span class="number">0.2</span>, <span class="number">0.3</span>)</pre> + </ul> + + </dd> + <dt id="FontManager"> + <strong>FontManager (obj, template, abstract, sizeMod, styleOverride, red, green, blue)</strong> + </dt> + <dd> + Adds a font object to the custom SVUI font manager. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>obj</strong><td> + Font object. + </td></tr> + <tr><td style="width:20% !important;"><strong>template</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + Internal name of the media-font to be assigned. + </td></tr> + <tr><td style="width:20% !important;"><strong>abstract</strong><td> + A multi-use flag. + </td></tr> + <tr><td style="width:20% !important;"><strong>sizeMod</strong><td> + Font size override. + </td></tr> + <tr><td style="width:20% !important;"><strong>styleOverride</strong><td> + Outline override. + </td></tr> + <tr><td style="width:20% !important;"><strong>red</strong><td> + <span class="types"><span class="type">number</span></span> + Color, red value. + </td></tr> + <tr><td style="width:20% !important;"><strong>green</strong><td> + <span class="types"><span class="type">number</span></span> + Color, green value. + </td></tr> + <tr><td style="width:20% !important;"><strong>blue</strong><td> + <span class="types"><span class="type">number</span></span> + Color, blue value. + </td></tr> +</tbody></table> + + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example">SV:FontManager(FontObject, <span class="string">'default'</span>, <span class="keyword">false</span>, <span class="keyword">false</span>, <span class="string">'OUTLINE'</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>)</pre> + </ul> + + </dd> + <dt id="GenerateFontOptionGroup"> + <strong>GenerateFontOptionGroup (groupName, groupCount, groupOverview, groupList)</strong> + </dt> + <dd> + Create an add-in set of specific font configuration options. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>groupName</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + Options group to insert into. + </td></tr> + <tr><td style="width:20% !important;"><strong>groupCount</strong><td> + <span class="types"><span class="type">number</span></span> + Option order for this option. + </td></tr> + <tr><td style="width:20% !important;"><strong>groupOverview</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + Option group name for this option. + </td></tr> + <tr><td style="width:20% !important;"><strong>groupList</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a></span> + Array of relevant font data. + </td></tr> +</tbody></table> + + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example">SV:GenerateFontOptionGroup(groupName, groupCount, groupOverview, groupList)</pre> + </ul> + + </dd> + </dl> + </div> + </div> + </div> + </div> +</div> +</div> +</div> +</section> +</div> +<!-- END CONTENT --> + +<!-- BEGIN FOOTER // --> +<footer> + <div class="right-section"> + <ul class="link-list"> + <li> + <span style="color:#5fafff">Last updated 2015-08-26 14:32:22</span> + </li> + </ul> + </div> +</footer> +<!-- END FOOTER // --> + +</div> +<!-- END LAYOUT --> + +<!-- Core JavaScript --> +<script src="http://supervillainui.com/js/app.min.js"></script> +<script src="http://supervillainui.com/js/extended/jquery-1.11.0.js"></script> +<script src="http://supervillainui.com/js/extended/jquery.easing.min.js"></script> +<script src="http://supervillainui.com/js/extended/jquery.swipebox.min.js"></script> +</body> +</html> diff --git a/SVUI_!Core/guide/docs/index.html b/SVUI_!Core/guide/docs/index.html index 1755054..1477af1 100644 --- a/SVUI_!Core/guide/docs/index.html +++ b/SVUI_!Core/guide/docs/index.html @@ -7,10 +7,6 @@ <link rel="stylesheet" href="ldoc.css" type="text/css" /> <!-- Fonts --> <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> </head> <body id="page-top" data-spy="scroll" data-target=".layout-header"> <div class="skinned-page"></div> @@ -32,13 +28,17 @@ <div class="layout-drawer"> <span class="navigation-title" style="padding:">Contents</span> <nav class="navigation" style="padding-top:0 !important;"> - <div class="navigation-subtitle">Addon</div> - <a href="index.html" class="navigation-link current-link">SVUI</a> +<div class="navigation-subtitle">Addons</div> +<a href="index.html" class="navigation-link current-link">SVUI_Core</a> +<a href="#Messages" class="navigation-link"> Messages </a> +<a href="#Utilities" class="navigation-link"> Utilities </a> +<a href="#media_Functions" class="navigation-link"> media Functions</a> +<div class="navigation-spacer"></div> <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Manual</div> +<div class="navigation-subtitle">Manual</div> <a href="manual/doc.md.html" class="navigation-link">doc</a> <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Libraries</div> +<div class="navigation-subtitle">Libraries</div> <a href="libraries/Librarian.html" class="navigation-link">Librarian</a> <a href="libraries/LUA.html" class="navigation-link">LUA</a> <a href="libraries/AceVillain.html" class="navigation-link">AceVillain</a> @@ -64,7 +64,7 @@ <div class="card"> <div class="card-header flex--expand"> <div class="card-header-title flex--centered"> - <span class="badge" data-badge="Module">SVUI</span> + <span class="badge" data-badge="Module">SVUI_Core</span> </div> </div> <div class="card-actions flex--expand"> @@ -72,22 +72,587 @@ </div> <div class="card-section"> <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - SuperVillain UI Core Module. - </p> - <h5 class="info-header">Info:</h5> - <p class="preface"> - <ul> + <h4 class="section-label">Info:</h4> + <ul> + <li> SuperVillain UI Core Module.</li> <li><strong>Release</strong>: 1.0.0</li> <li><strong>Author</strong>: Steven Jackson (2014)</li> - </ul> - </p> -<h5 class="info-header">Summary:</h5> -<p class="preface"> -</p> + <hr /> + </ul> + <h5 class="section-label">Construct:</h5> + <pre class="example"> + <span class="comment">-- Every other file will set a reference to the addon using this variable. Here is how we set it. +</span> + <span class="comment">-- METHOD 1 ---------------------------------------------------------------- +</span> <span class="comment">-- if we are setting this inside the core.lua file then use this method +</span> <span class="keyword">local</span> global = <span class="string">"SVUI_Global"</span> <span class="comment">-- reference to SavedVariables +</span> <span class="keyword">local</span> errors = <span class="string">"SVUI_Errors"</span> <span class="comment">-- reference to SavedVariables +</span> <span class="keyword">local</span> private = <span class="string">"SVUI_Private"</span> <span class="comment">-- reference to SavedVariables +</span> <span class="keyword">local</span> media = <span class="string">"SVUI_Media"</span> <span class="comment">-- reference to SavedVariables +</span> <span class="keyword">local</span> shared = <span class="string">"SVUI_Shared"</span> <span class="comment">-- reference to SavedVariables +</span> + <span class="keyword">local</span> Registry = Librarian(<span class="string">"Registry"</span>) <span class="comment">-- now pull down the Registry object +</span> <span class="comment">-- finally we use the 'NewCore' function specifically for this +</span> <span class="keyword">local</span> SV = Registry:NewCore(global, errors, private, media, shared) + + <span class="comment">-- METHOD 2 ---------------------------------------------------------------- +</span> <span class="comment">-- if we are setting the variable in any other file then use this method +</span> <span class="keyword">local</span> SV = _G[<span class="string">'SVUI'</span>]</pre> + <hr /> + <h5 class="section-label">Summary:</h5> + <div style="padding:6px 0px;"><a href="#Messages" style="color:#ff5500">Jump To: Messages ⋙</a></div> + <table class="function_list"> + <tr> + <td class="name" nowrap><a href="#SCTMessage">SCTMessage (message, red, green, blue, displayType)</a></td> + <td class="summary">Send messages to the scrolling message frame (combat text).</td> + </tr> + <tr> + <td class="name" nowrap><a href="#AddonMessage">AddonMessage (message)</a></td> + <td class="summary">Send messages to the chat frame prefixed with the addon branding.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#CharacterMessage">CharacterMessage (message)</a></td> + <td class="summary">Send messages to the chat frame as if they came from your character.</td> + </tr> + </table> + <div style="padding:6px 0px;"><a href="#Utilities" style="color:#ff5500">Jump To: Utilities ⋙</a></div> + <table class="function_list"> + <tr> + <td class="name" nowrap><a href="#fubar">fubar ()</a></td> + <td class="summary">Dummy function used to override existing methods, effectively killing them.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#StaticPopup_Show">StaticPopup_Show (arg)</a></td> + <td class="summary">Request specific ‘Static Popup’ windows.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#ResetAllUI">ResetAllUI ()</a></td> + <td class="summary">Reset all SVUI created settings to defaults.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#ResetUI">ResetUI ()</a></td> + <td class="summary">Reset layout positions back to their default.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#ToggleConfig">ToggleConfig ()</a></td> + <td class="summary">Open the config menu (‘/sv’).</td> + </tr> + <tr> + <td class="name" nowrap><a href="#VersionCheck">VersionCheck ()</a></td> + <td class="summary">Checks to see which (if any) version of the core that the client has installed.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#RefreshEverything">RefreshEverything ()</a></td> + <td class="summary">Reloads all current packages and modules.</td> + </tr> + </table> + <div style="padding:6px 0px;"><a href="#media_Functions" style="color:#ff5500">Jump To: media Functions⋙</a></div> + <table class="function_list"> + <tr> + <td class="name" nowrap><a href="#ColorGradient">ColorGradient (percentage, ...)</a></td> + <td class="summary">Returns a color value based on percentages.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#HexColor">HexColor (red, green, blue)</a></td> + <td class="summary">Returns a hexadecimal color value.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#FontManager">FontManager (obj, template, abstract, sizeMod, styleOverride, red, green, blue)</a></td> + <td class="summary">Adds a font object to the custom SVUI font manager.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#GenerateFontOptionGroup">GenerateFontOptionGroup (groupName, groupCount, groupOverview, groupList)</a></td> + <td class="summary">Create an add-in set of specific font configuration options.</td> + </tr> + </table> + <hr /> <br /> <br /> + <h6 class="section-label" id="Messages">Messages + + <small> + Addon Message Handlers + </small> + </h6> + <dl class="function"> + <dt id="SCTMessage"> + <strong>SCTMessage (message, red, green, blue, displayType)</strong> + </dt> + <dd> + Send messages to the scrolling message frame (combat text). + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>message</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + The dialog to be displayed. + </td></tr> + <tr><td style="width:20% !important;"><strong>red</strong><td> + Text coloring, red value. + </td></tr> + <tr><td style="width:20% !important;"><strong>green</strong><td> + Text coloring, green value. + </td></tr> + <tr><td style="width:20% !important;"><strong>blue</strong><td> + Text coloring, blue value. + </td></tr> + <tr><td style="width:20% !important;"><strong>displayType</strong><td> + Special animation type (STICKY, CRITICAL or nil). + </td></tr> +</tbody></table> + + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example">SV:SCTMessage(<span class="string">'My message'</span>, <span class="number">0.1</span>, <span class="number">0.2</span>, <span class="number">0.3</span>, <span class="string">'STICKY'</span>)</pre> + </ul> + + </dd> + <dt id="AddonMessage"> + <strong>AddonMessage (message)</strong> + </dt> + <dd> + Send messages to the chat frame prefixed with the addon branding. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>message</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + The dialog to be displayed. + </td></tr> +</tbody></table> + + + + + + </dd> + <dt id="CharacterMessage"> + <strong>CharacterMessage (message)</strong> + </dt> + <dd> + Send messages to the chat frame as if they came from your character. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>message</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + The dialog to be displayed. + </td></tr> +</tbody></table> + + + + + + </dd> + </dl> + <h6 class="section-label" id="Utilities">Utilities + + <small> + Utilities used and shared by the SVUI core. + </small> + </h6> + <dl class="function"> + <dt id="fubar"> + <strong>fubar ()</strong> + </dt> + <dd> + Dummy function used to override existing methods, effectively killing them. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> + <ol> + + nothing. + </ol> + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example"> + <span class="comment">-- Kill a function +</span> SomeObject.some_function = SV.fubar</pre> + </ul> + + </dd> + <dt id="StaticPopup_Show"> + <strong>StaticPopup_Show (arg)</strong> + </dt> + <dd> + Request specific ‘Static Popup’ windows. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>arg</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + Name of the popup + </td></tr> +</tbody></table> + + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example"> + <span class="comment">-- Open the 'Reload UI' popup +</span> SV:StaticPopup_Show(<span class="string">'RL_CLIENT'</span>)</pre> + </ul> + + </dd> + <dt id="ResetAllUI"> + <strong>ResetAllUI ()</strong> + </dt> + <dd> + Reset all SVUI created settings to defaults. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + + + + + + </dd> + <dt id="ResetUI"> + <strong>ResetUI ()</strong> + </dt> + <dd> + Reset layout positions back to their default. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + + + + + + </dd> + <dt id="ToggleConfig"> + <strong>ToggleConfig ()</strong> + </dt> + <dd> + Open the config menu (‘/sv’). + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + + + + + + </dd> + <dt id="VersionCheck"> + <strong>VersionCheck ()</strong> + </dt> + <dd> + Checks to see which (if any) version of the core that the client has installed. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + + + + + + </dd> + <dt id="RefreshEverything"> + <strong>RefreshEverything ()</strong> + </dt> + <dd> + Reloads all current packages and modules. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + + + + + + </dd> + </dl> + <h6 class="section-label" id="media_Functions">media Functions + + </h6> + <dl class="function"> + <dt id="ColorGradient"> + <strong>ColorGradient (percentage, ...)</strong> + </dt> + <dd> + Returns a color value based on percentages. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>percentage</strong><td> + <span class="types"><span class="type">number</span></span> + The needed gradient percent. + </td></tr> + <tr><td style="width:20% !important;"><strong>...</strong><td> + (vararg) remaining arguments are up to 3 sets of numeric color values (r,g,b). + </td></tr> +</tbody></table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> + <ol> + + red value, green value, blue value + </ol> + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example">SV:ColorGradient(<span class="number">50</span>,<span class="number">1</span>,<span class="number">0</span>,<span class="number">0</span>,<span class="number">1</span>,<span class="number">1</span>,<span class="number">0</span>,<span class="number">0</span>,<span class="number">1</span>,<span class="number">0</span>)</pre> + </ul> + + </dd> + <dt id="HexColor"> + <strong>HexColor (red, green, blue)</strong> + </dt> + <dd> + Returns a hexadecimal color value. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>red</strong><td> + <span class="types"><span class="type">number</span></span> + Color, red value. + </td></tr> + <tr><td style="width:20% !important;"><strong>green</strong><td> + <span class="types"><span class="type">number</span></span> + Color, green value. + </td></tr> + <tr><td style="width:20% !important;"><strong>blue</strong><td> + <span class="types"><span class="type">number</span></span> + Color, blue value. + </td></tr> +</tbody></table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> + <ol> + + Hexadecimal string color + </ol> + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example">SV:HexColor(<span class="number">0.1</span>, <span class="number">0.2</span>, <span class="number">0.3</span>)</pre> + </ul> + + </dd> + <dt id="FontManager"> + <strong>FontManager (obj, template, abstract, sizeMod, styleOverride, red, green, blue)</strong> + </dt> + <dd> + Adds a font object to the custom SVUI font manager. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>obj</strong><td> + Font object. + </td></tr> + <tr><td style="width:20% !important;"><strong>template</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + Internal name of the media-font to be assigned. + </td></tr> + <tr><td style="width:20% !important;"><strong>abstract</strong><td> + A multi-use flag. + </td></tr> + <tr><td style="width:20% !important;"><strong>sizeMod</strong><td> + Font size override. + </td></tr> + <tr><td style="width:20% !important;"><strong>styleOverride</strong><td> + Outline override. + </td></tr> + <tr><td style="width:20% !important;"><strong>red</strong><td> + <span class="types"><span class="type">number</span></span> + Color, red value. + </td></tr> + <tr><td style="width:20% !important;"><strong>green</strong><td> + <span class="types"><span class="type">number</span></span> + Color, green value. + </td></tr> + <tr><td style="width:20% !important;"><strong>blue</strong><td> + <span class="types"><span class="type">number</span></span> + Color, blue value. + </td></tr> +</tbody></table> + + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example">SV:FontManager(FontObject, <span class="string">'default'</span>, <span class="keyword">false</span>, <span class="keyword">false</span>, <span class="string">'OUTLINE'</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>)</pre> + </ul> + + </dd> + <dt id="GenerateFontOptionGroup"> + <strong>GenerateFontOptionGroup (groupName, groupCount, groupOverview, groupList)</strong> + </dt> + <dd> + Create an add-in set of specific font configuration options. + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> +<table> +<tbody> + <tr><td style="width:20% !important;"><strong>groupName</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + Options group to insert into. + </td></tr> + <tr><td style="width:20% !important;"><strong>groupCount</strong><td> + <span class="types"><span class="type">number</span></span> + Option order for this option. + </td></tr> + <tr><td style="width:20% !important;"><strong>groupOverview</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + Option group name for this option. + </td></tr> + <tr><td style="width:20% !important;"><strong>groupList</strong><td> + <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.5">table</a></span> + Array of relevant font data. + </td></tr> +</tbody></table> + + + + +<div style="padding:12px 0 6px;font-size:15px;"><strong>Usage:</strong></div> + <ul> + <pre class="example">SV:GenerateFontOptionGroup(groupName, groupCount, groupOverview, groupList)</pre> + </ul> + + </dd> + </dl> </div> </div> </div> @@ -104,7 +669,7 @@ <div class="right-section"> <ul class="link-list"> <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:32:23</span> + <span style="color:#5fafff">Last updated 2015-08-26 14:32:22</span> </li> </ul> </div> diff --git a/SVUI_!Core/guide/docs/ldoc.css b/SVUI_!Core/guide/docs/ldoc.css index cdfa9c4..2a8d337 100644 --- a/SVUI_!Core/guide/docs/ldoc.css +++ b/SVUI_!Core/guide/docs/ldoc.css @@ -6,4 +6,4 @@ /*** * Custom Styles for the SVUI Site. */ -body,html{height:100%;background-color:#333}td,tr{height:auto!important}body{text-shadow:0 1px 3px rgba(0,0,0,.12);font-family:Roboto,"Helvetica Neue",Helvetica,Arial,sans-serif}h1,h2,h3,h4,h5,h6{margin:0;font-size:18px;text-transform:uppercase;letter-spacing:1px;color:#000;text-shadow:1px 1px 4px #888}table{border-collapse:collapse}tr{min-height:28px}p{margin:0;padding:12px 20px;line-height:20px;font-size:15px}a{color:#07F;text-shadow:1px 1px 2px #ccc,-1px -1px 1px #fff;background-color:transparent;transition:all .2s ease-in-out}a:focus,a:hover{text-decoration:none;color:#0C0;text-shadow:0 0 1px #fff,0 0 1px #fff}.button-icon{text-transform:none;transition:all .3s ease-in-out;color:#1FCCFF;padding:12px 16px;font-size:28px;line-height:1.33;border-radius:50px}.button-icon,.button-icon:focus,.button-icon:hover{border:1px solid transparent;background-color:transparent}.button-icon:focus,.button-icon:hover{outline:0;color:#FF0}.current-link{background-color:rgba(0,255,0,.2)}.layout-title{text-transform:uppercase;letter-spacing:1px;color:#FF6F00;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #000}.layout-drawer{color:#fff;text-shadow:0 1px 3px rgba(0,0,0,.5);background-color:#3F3F3F;border-right:1px solid #000}.navigation-link{padding:2px 40px!important;color:#fff!important;text-shadow:1px 1px 2px #000!important}.navigation-link:focus,.navigation-link:hover{text-decoration:none;color:#0C0;text-shadow:1px 1px 2px #000!important}.navigation-link .material-icons{font-size:24px;margin-right:32px}.navigation-subtitle,.navigation-title{display:block;position:relative;border-bottom:1px solid rgba(0,0,0,.3);font-size:20px;line-height:1;letter-spacing:.02em;font-weight:400;box-sizing:border-box}.navigation-title{color:#888;padding:2px 8px 8px}.navigation-subtitle{padding:8px 16px 4px!important;color:#FF0;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #000}.navigation-spacer{padding:1px 0;border-bottom:1px solid rgba(100,100,100,.2);-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1}.container-title{letter-spacing:0;color:#FF6F00;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #C50}.container-subtitle{font-size:14px;letter-spacing:0;color:#FF0;text-shadow:-.1em .18em .14em #B30,-.08em .1em .08em #C40,-.22em .35em .1em #000,.18em -.1em .2em #000}.card-header-title{text-transform:uppercase;font-size:26px;color:#1FCCFF;text-shadow:1px 3px 1px #000,0 3px 20px #04C;letter-spacing:0}.card-header-subtitle{color:#000;text-shadow:0 0 3px #999}.section-actions,.section-dialog{background-color:#fff!important} +body,html{height:100%;background-color:#333}td,tr{height:auto!important}body{text-shadow:0 1px 3px rgba(0,0,0,.12);font-family:Roboto,"Helvetica Neue",Helvetica,Arial,sans-serif}h1,h2,h3,h4,h5,h6{margin:0;text-transform:uppercase;letter-spacing:1px;font-weight:500;color:#000;text-shadow:1px 1px 4px #888}h1{font-size:24px}h2{font-size:22px}h3{font-size:20px}h4{font-size:18px}h5{font-size:16px}h6{font-size:14px}small{font-size:.8em!important}small:before{content:"\00a0\00a0//\00a0\00a0";display:inline-block}small:after{content:" ";clear:both}table{border-collapse:collapse}tr{min-height:28px}p{margin:0;padding:12px 20px;line-height:20px;font-size:15px}a{color:#07F;text-shadow:1px 1px 2px #ccc,-1px -1px 1px #fff;background-color:transparent;transition:all .2s ease-in-out}a:focus,a:hover{text-decoration:none;color:#0C0;text-shadow:0 0 1px #fff,0 0 1px #fff}.section-label{display:inline-block;padding:4px 12px;border-radius:50px;margin-left:-12px;line-height:1!important;border:2px solid rgba(0,0,0,.12)}h1.section-label,h2.section-label,h3.section-label{background-color:rgba(255,75,0,.4)}h4.section-label{background-color:rgba(255,255,0,.4)}h5.section-label{background-color:rgba(75,255,0,.4)}h6.section-label{background-color:rgba(0,200,255,.4)}.button-icon{text-transform:none;transition:all .3s ease-in-out;color:#1FCCFF;padding:12px 16px;font-size:28px;line-height:1.33;border-radius:50px}.button-icon,.button-icon:focus,.button-icon:hover{border:1px solid transparent;background-color:transparent}.card-header-title,.layout-title,.navigation-link{text-transform:uppercase}.button-icon:focus,.button-icon:hover{outline:0;color:#FF0}.current-link{background-color:rgba(0,255,0,.2)}.layout-title{letter-spacing:1px;color:#FF6F00;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #000}.layout-drawer{color:#fff;text-shadow:0 1px 3px rgba(0,0,0,.5);background-color:#3F3F3F;border-right:1px solid #000}.navigation-link{padding:2px 40px!important;color:#fff!important;text-shadow:1px 1px 2px #000!important}.navigation-link:focus,.navigation-link:hover{text-decoration:none;color:#0C0;text-shadow:1px 1px 2px #000!important}.navigation-link .material-icons{font-size:24px;margin-right:32px}.navigation-subtitle,.navigation-title{display:block;position:relative;border-bottom:1px solid rgba(0,0,0,.3);font-size:20px;line-height:1;letter-spacing:.02em;font-weight:400;box-sizing:border-box}.navigation-title{color:#888;padding:2px 8px 8px}.navigation-subtitle{padding:8px 16px 4px!important;color:#FF0;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #000}.navigation-spacer{padding:1px 0;border-bottom:1px solid rgba(100,100,100,.2);-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1}.container-title{letter-spacing:0;color:#FF6F00;text-shadow:-.1em .14em .01em #B30,-.08em .02em .05em #F30,-.18em .2em .03em #000,-.08em .2em .03em #000,.1em -.05em .03em #000,-.12em -.02em .03em #000,-.08em .1em 1em #C50}.container-subtitle{font-size:14px;letter-spacing:0;color:#FF0;text-shadow:-.1em .18em .14em #B30,-.08em .1em .08em #C40,-.22em .35em .1em #000,.18em -.1em .2em #000}.card-header{padding:0!important}.card-header-title{font-size:26px;color:#1FCCFF;text-shadow:1px 3px 1px #000,0 3px 20px #04C;letter-spacing:0}.card-header-subtitle{color:#000;text-shadow:0 0 3px #999}.section-actions,.section-dialog{background-color:#fff!important} diff --git a/SVUI_!Core/guide/docs/libraries/AceVillain.html b/SVUI_!Core/guide/docs/libraries/AceVillain.html index 70c7f62..0f7b6f6 100644 --- a/SVUI_!Core/guide/docs/libraries/AceVillain.html +++ b/SVUI_!Core/guide/docs/libraries/AceVillain.html @@ -7,10 +7,6 @@ <link rel="stylesheet" href="../ldoc.css" type="text/css" /> <!-- Fonts --> <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> </head> <body id="page-top" data-spy="scroll" data-target=".layout-header"> <div class="skinned-page"></div> @@ -32,15 +28,15 @@ <div class="layout-drawer"> <span class="navigation-title" style="padding:">Contents</span> <nav class="navigation" style="padding-top:0 !important;"> - <div class="navigation-subtitle">Libraries</div> +<div class="navigation-subtitle">Libraries</div> <a href="../libraries/Librarian.html" class="navigation-link">Librarian</a> <a href="../libraries/LUA.html" class="navigation-link">LUA</a> - <a href="../libraries/AceVillain.html" class="navigation-link current-link">AceVillain</a> +<a href="../libraries/AceVillain.html" class="navigation-link current-link">AceVillain</a> <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Addon</div> - <a href="../index.html" class="navigation-link">SVUI</a> +<div class="navigation-subtitle">Addons</div> + <a href="../index.html" class="navigation-link">SVUI_Core</a> <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Manual</div> +<div class="navigation-subtitle">Manual</div> <a href="../manual/doc.md.html" class="navigation-link">doc</a> <div class="navigation-spacer"></div> </nav> @@ -72,21 +68,16 @@ </div> <div class="card-section"> <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - - - </p> - <h5 class="info-header">Info:</h5> - <p class="preface"> - <ul> + <h4 class="section-label">Info:</h4> + <ul> + <li> +</li> <li><strong>Release</strong>: 1.0.0</li> <li><strong>Author</strong>: Steven Jackson (2014)</li> - </ul> - </p> -<h5 class="info-header">Summary:</h5> -<p class="preface"> -</p> + <hr /> + </ul> + <h5 class="section-label">Summary:</h5> + <hr /> <br /> <br /> </div> @@ -105,7 +96,7 @@ <div class="right-section"> <ul class="link-list"> <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:32:23</span> + <span style="color:#5fafff">Last updated 2015-08-26 14:32:22</span> </li> </ul> </div> diff --git a/SVUI_!Core/guide/docs/libraries/LUA.html b/SVUI_!Core/guide/docs/libraries/LUA.html index b44c02a..773b26a 100644 --- a/SVUI_!Core/guide/docs/libraries/LUA.html +++ b/SVUI_!Core/guide/docs/libraries/LUA.html @@ -7,10 +7,6 @@ <link rel="stylesheet" href="../ldoc.css" type="text/css" /> <!-- Fonts --> <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> </head> <body id="page-top" data-spy="scroll" data-target=".layout-header"> <div class="skinned-page"></div> @@ -32,9 +28,9 @@ <div class="layout-drawer"> <span class="navigation-title" style="padding:">Contents</span> <nav class="navigation" style="padding-top:0 !important;"> - <div class="navigation-subtitle">Libraries</div> +<div class="navigation-subtitle">Libraries</div> <a href="../libraries/Librarian.html" class="navigation-link">Librarian</a> - <a href="../libraries/LUA.html" class="navigation-link current-link">LUA</a> +<a href="../libraries/LUA.html" class="navigation-link current-link">LUA</a> <a href="#Math" class="navigation-link"> Math </a> <a href="#Pickle" class="navigation-link"> Pickle </a> <a href="#String" class="navigation-link"> String </a> @@ -42,10 +38,10 @@ <div class="navigation-spacer"></div> <a href="../libraries/AceVillain.html" class="navigation-link">AceVillain</a> <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Addon</div> - <a href="../index.html" class="navigation-link">SVUI</a> +<div class="navigation-subtitle">Addons</div> + <a href="../index.html" class="navigation-link">SVUI_Core</a> <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Manual</div> +<div class="navigation-subtitle">Manual</div> <a href="../manual/doc.md.html" class="navigation-link">doc</a> <div class="navigation-spacer"></div> </nav> @@ -77,20 +73,15 @@ </div> <div class="card-section"> <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - - - </p> - <h5 class="info-header">Info:</h5> - <p class="preface"> - <ul> + <h4 class="section-label">Info:</h4> + <ul> + <li> +</li> <li><strong>Release</strong>: 1.0.0</li> <li><strong>Author</strong>: Steven Jackson (2014)</li> - </ul> - </p> -<h5 class="info-header">Summary:</h5> -<p class="preface"> + <hr /> + </ul> + <h5 class="section-label">Summary:</h5> <div style="padding:6px 0px;"><a href="#Math" style="color:#ff5500">Jump To: Math ⋙</a></div> <table class="function_list"> <tr> @@ -127,6 +118,10 @@ <td class="name" nowrap><a href="#string.explode">string.explode (data, delim)</a></td> <td class="summary">String to array utility.</td> </tr> + <tr> + <td class="name" nowrap><a href="#prettify">prettify</a></td> + <td class="summary">PRETTY PRINT FOR TABLES</td> + </tr> </table> <div style="padding:6px 0px;"><a href="#Table" style="color:#ff5500">Jump To: Table ⋙</a></div> <table class="function_list"> @@ -139,14 +134,15 @@ <td class="summary">Copy all table data from a source to another table</td> </tr> </table> -</p> + <hr /> <br /> <br /> - <h4 class="section-header has-description"><a name="Math"></a>Math </h4> + <h6 class="section-label" id="Math">Math - <div class="section-description"> + <small> UTILITIES - </div> + </small> + </h6> <dl class="function"> <dt id="math.parsefloat"> <strong>math.parsefloat (value, decimal)</strong> @@ -154,6 +150,14 @@ <dd> Integer float utility for lua. <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> <table> @@ -177,11 +181,12 @@ </dd> </dl> - <h4 class="section-header has-description"><a name="Pickle"></a>Pickle </h4> + <h6 class="section-label" id="Pickle">Pickle - <div class="section-description"> + <small> UTILITIES - </div> + </small> + </h6> <dl class="function"> <dt id="Pickle"> <strong>Pickle</strong> @@ -189,6 +194,14 @@ <dd> Global class used by pickle/unpickle functions. <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Fields:</strong></div> <table> @@ -210,6 +223,14 @@ <dd> A table serialization utility for lua. <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> <table> @@ -235,6 +256,14 @@ <dd> Un-serialization tool (pretty sure thats not a word). <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> <table> @@ -255,11 +284,12 @@ </dd> </dl> - <h4 class="section-header has-description"><a name="String"></a>String </h4> + <h6 class="section-label" id="String">String - <div class="section-description"> + <small> UTILITIES - </div> + </small> + </h6> <dl class="function"> <dt id="string.encode"> <strong>string.encode (data)</strong> @@ -267,6 +297,14 @@ <dd> Base64 encoding tool. <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> <table> @@ -292,6 +330,14 @@ <dd> Base64 decoding tool. <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> <table> @@ -317,6 +363,14 @@ <dd> String to array utility. <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> <table> @@ -339,12 +393,34 @@ </dd> + <dt id="prettify"> + <strong>prettify</strong> + </dt> + <dd> + PRETTY PRINT FOR TABLES + <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + + + + + + + </dd> </dl> - <h4 class="section-header has-description"><a name="Table"></a>Table </h4> + <h6 class="section-label" id="Table">Table - <div class="section-description"> + <small> UTILITIES - </div> + </small> + </h6> <dl class="function"> <dt id="table.tostring"> <strong>table.tostring (tbl, pretty)</strong> @@ -352,6 +428,14 @@ <dd> Dump table contents to string <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> <table> @@ -380,6 +464,14 @@ <dd> Copy all table data from a source to another table <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> <table> @@ -422,7 +514,7 @@ <div class="right-section"> <ul class="link-list"> <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:32:23</span> + <span style="color:#5fafff">Last updated 2015-08-26 14:32:22</span> </li> </ul> </div> diff --git a/SVUI_!Core/guide/docs/libraries/Librarian.html b/SVUI_!Core/guide/docs/libraries/Librarian.html index 9de9c76..5c346ac 100644 --- a/SVUI_!Core/guide/docs/libraries/Librarian.html +++ b/SVUI_!Core/guide/docs/libraries/Librarian.html @@ -7,10 +7,6 @@ <link rel="stylesheet" href="../ldoc.css" type="text/css" /> <!-- Fonts --> <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> </head> <body id="page-top" data-spy="scroll" data-target=".layout-header"> <div class="skinned-page"></div> @@ -32,18 +28,18 @@ <div class="layout-drawer"> <span class="navigation-title" style="padding:">Contents</span> <nav class="navigation" style="padding-top:0 !important;"> - <div class="navigation-subtitle">Libraries</div> - <a href="../libraries/Librarian.html" class="navigation-link current-link">Librarian</a> +<div class="navigation-subtitle">Libraries</div> +<a href="../libraries/Librarian.html" class="navigation-link current-link">Librarian</a> <a href="#Functions" class="navigation-link"> Functions</a> <a href="#Tables" class="navigation-link"> Tables</a> <div class="navigation-spacer"></div> <a href="../libraries/LUA.html" class="navigation-link">LUA</a> <a href="../libraries/AceVillain.html" class="navigation-link">AceVillain</a> <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Addon</div> - <a href="../index.html" class="navigation-link">SVUI</a> +<div class="navigation-subtitle">Addons</div> + <a href="../index.html" class="navigation-link">SVUI_Core</a> <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Manual</div> +<div class="navigation-subtitle">Manual</div> <a href="../manual/doc.md.html" class="navigation-link">doc</a> <div class="navigation-spacer"></div> </nav> @@ -75,19 +71,14 @@ </div> <div class="card-section"> <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - Librarian is a versioning manager for use with proprietary SVUI libraries. - </p> - <h5 class="info-header">Info:</h5> - <p class="preface"> - <ul> + <h4 class="section-label">Info:</h4> + <ul> + <li> Librarian is a versioning manager for use with proprietary SVUI libraries.</li> <li><strong>Release</strong>: 1.0.0</li> <li><strong>Author</strong>: Steven Jackson (2014)</li> - </ul> - </p> -<h5 class="info-header">Summary:</h5> -<p class="preface"> + <hr /> + </ul> + <h5 class="section-label">Summary:</h5> <div style="padding:6px 0px;"><a href="#Functions" style="color:#ff5500">Jump To: Functions⋙</a></div> <table class="function_list"> <tr> @@ -106,11 +97,12 @@ <td class="summary">Global Librarian object.</td> </tr> </table> -</p> + <hr /> <br /> <br /> - <h4 class="section-header "><a name="Functions"></a>Functions</h4> + <h6 class="section-label" id="Functions">Functions + </h6> <dl class="function"> <dt id="NewLibrary"> <strong>NewLibrary (libName)</strong> @@ -118,6 +110,14 @@ <dd> Adds a new lib to saved objects. <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> <table> @@ -143,6 +143,14 @@ <dd> Retrieve a saved library object. <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> <table> @@ -166,8 +174,9 @@ </dd> </dl> - <h4 class="section-header "><a name="Tables"></a>Tables</h4> + <h6 class="section-label" id="Tables">Tables + </h6> <dl class="function"> <dt id="Librarian"> <strong>Librarian</strong> @@ -175,6 +184,14 @@ <dd> Global Librarian object. <br /> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> + </tbody> + </table> <div style="padding:12px 0 6px;font-size:15px;"><strong>Fields:</strong></div> <table> @@ -207,7 +224,7 @@ <div class="right-section"> <ul class="link-list"> <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:32:23</span> + <span style="color:#5fafff">Last updated 2015-08-26 14:32:22</span> </li> </ul> </div> diff --git a/SVUI_!Core/guide/docs/libraries/SVUI.html b/SVUI_!Core/guide/docs/libraries/SVUI.html deleted file mode 100644 index 19c4bd5..0000000 --- a/SVUI_!Core/guide/docs/libraries/SVUI.html +++ /dev/null @@ -1,123 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SVUI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> - <!-- Fonts --> - <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> -</head> -<body id="page-top" data-spy="scroll" data-target=".layout-header"> -<div class="skinned-page"></div> -<div id="message-depot"></div> -<!-- BEGIN LAYOUT --> -<div class="layout js-layout js-skins layout-overlay-drawer-button layout-shadow layout-fixed-header layout-fixed-drawer"> - - -<!-- BEGIN NAV // --> - <div class="layout-header"> - <div class="layout-header-row"> - <span class="layout-title">Documentation</span> - <div class="layout-spacer"></div> - <nav class="navigation"> - </nav> - </div> - </div> - - <div class="layout-drawer"> - <span class="navigation-title" style="padding:">Contents</span> - <nav class="navigation" style="padding-top:0 !important;"> - <div class="navigation-subtitle">Libraries</div> - <a href="../index.html" class="navigation-link current-link">SVUI</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Manual</div> - <a href="../manual/doc.md.html" class="navigation-link">doc</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Source</div> - <a href="../source/Librarian.html" class="navigation-link">Librarian</a> - <a href="../source/LUA.html" class="navigation-link">LUA</a> - <a href="../source/AceVillain.html" class="navigation-link">AceVillain</a> - <div class="navigation-spacer"></div> - </nav> - </div> - - <span class="layout-title floating-title no-desktop">Menu</span> - - <div class="layout-drawer-button"> - <i class="layout-drawer-button-icon menu-icon"></i> - </div> - <!-- END NAV // --> - - <!-- BEGIN CONTENT // --> - <div class="layout-content"> - -<section style="padding:0;"> -<div class="grid"> -<div class="cell cell-12-col"> -<div class="container"> - <div class="comic"> - <div class="card"> - <div class="card-header flex--expand"> - <div class="card-header-title flex--centered"> - <span class="badge" data-badge="Module">SVUI</span> - </div> - </div> - <div class="card-actions flex--expand"> - <div class="card-header-subtitle flex--centered">SVUI is our global addon object.</div> - </div> - <div class="card-section"> - <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - SuperVillain UI Core Module. - </p> - <h5 class="info-header">Info:</h5> - <p class="preface"> - <ul> - <li><strong>Release</strong>: 1.0.0</li> - <li><strong>Author</strong>: Steven Jackson (2014)</li> - </ul> - </p> -<h5 class="info-header">Summary:</h5> -<p class="preface"> -</p> - <br /> - <br /> - </div> - </div> - </div> - </div> -</div> -</div> -</div> -</section> -</div> -<!-- END CONTENT --> - -<!-- BEGIN FOOTER // --> -<footer> - <div class="right-section"> - <ul class="link-list"> - <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:19:24</span> - </li> - </ul> - </div> -</footer> -<!-- END FOOTER // --> - -</div> -<!-- END LAYOUT --> - -<!-- Core JavaScript --> -<script src="http://supervillainui.com/js/app.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery-1.11.0.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.easing.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.swipebox.min.js"></script> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfig-3.0.html b/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfig-3.0.html deleted file mode 100644 index f138c72..0000000 --- a/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfig-3.0.html +++ /dev/null @@ -1,78 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SuperVillain UI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> -</head> -<body> - -<div id="container"> - -<div id="product"> - <div id="product_logo"></div> - <div id="product_name"><big><b></b></big></div> - <div id="product_description"></div> -</div> <!-- id="product" --> - - -<div id="main"> - - -<!-- Menu --> - -<div id="navigation"> -<br/> -<h1>SuperVillain UI</h1> - -<ul> - <li><a href="../index.html">Index</a></li> -</ul> - - - -<h2>Libraries</h2> -<ul class="$(kind=='Topics' and '' or 'nowrap'"> - <li><strong>aceconfig-3.0.aceconfig-3.0</strong></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0.html">aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0</a></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0.html">aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0</a></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0.html">aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0</a></li> - <li><a href="../libraries/acegui-3.0.acegui-3.0.html">acegui-3.0.acegui-3.0</a></li> -</ul> -<h2>Manual</h2> -<ul class="$(kind=='Topics' and '' or 'nowrap'"> - <li><a href="../manual/doc.md.html">doc</a></li> -</ul> - -</div> - -<div id="content"> - -<h1>Module <code>aceconfig-3.0.aceconfig-3.0</code></h1> -<p>Register a option table with the AceConfig registry.</p> -<p> You can supply a slash command (or a table of slash commands) to register with AceConfigCmd directly.</p> - <h3>Usage:</h3> - <ul> - <pre class="example"> - local AceConfig = LibStub("AceConfig-3.0") - AceConfig:RegisterOptionsTable("MyAddon", myOptions, {"/myslash", "/my"})</pre> - </ul> - - - -<br/> -<br/> - - - - -</div> <!-- id="content" --> -</div> <!-- id="main" --> -<div id="about"> -<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i> -<i style="float:right;">Last updated 2015-08-25 09:24:20 </i> -</div> <!-- id="about" --> -</div> <!-- id="container" --> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0.html b/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0.html deleted file mode 100644 index d3ba09c..0000000 --- a/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0.html +++ /dev/null @@ -1,193 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SuperVillain UI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> -</head> -<body> - -<div id="container"> - -<div id="product"> - <div id="product_logo"></div> - <div id="product_name"><big><b></b></big></div> - <div id="product_description"></div> -</div> <!-- id="product" --> - - -<div id="main"> - - -<!-- Menu --> - -<div id="navigation"> -<br/> -<h1>SuperVillain UI</h1> - -<ul> - <li><a href="../index.html">Index</a></li> -</ul> - -<h2>Contents</h2> -<ul> -<li><a href="#Functions">Functions</a></li> -</ul> - - -<h2>Libraries</h2> -<ul class="$(kind=='Topics' and '' or 'nowrap'"> - <li><a href="../libraries/aceconfig-3.0.aceconfig-3.0.html">aceconfig-3.0.aceconfig-3.0</a></li> - <li><strong>aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0</strong></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0.html">aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0</a></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0.html">aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0</a></li> - <li><a href="../libraries/acegui-3.0.acegui-3.0.html">acegui-3.0.acegui-3.0</a></li> -</ul> -<h2>Manual</h2> -<ul class="$(kind=='Topics' and '' or 'nowrap'"> - <li><a href="../manual/doc.md.html">doc</a></li> -</ul> - -</div> - -<div id="content"> - -<h1>Module <code>aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0</code></h1> -<p>Grab hold of handler,set,get,func,etc if set (and remember old ones) - Note that we do NOT validate if method names are correct at this stage, - the handler may change before they're actually used!</p> -<p> -</p> - - -<h2><a href="#Functions">Functions</a></h2> -<table class="function_list"> - <tr> - <td class="name" nowrap><a href="#AceConfigCmd:HandleCommand">AceConfigCmd:HandleCommand (slashcmd, appName, input)</a></td> - <td class="summary">Handle the chat command.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceConfigCmd:CreateChatCommand">AceConfigCmd:CreateChatCommand (slashcmd, appName)</a></td> - <td class="summary">Utility function to create a slash command handler.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceConfigCmd:GetChatCommandOptions">AceConfigCmd:GetChatCommandOptions (slashcmd)</a></td> - <td class="summary">Utility function that returns the options table that belongs to a slashcommand.</td> - </tr> -</table> - -<br/> -<br/> - - - <h2 class="section-header "><a name="Functions"></a>Functions</h2> - - <dl class="function"> - <dt> - <a name = "AceConfigCmd:HandleCommand"></a> - <strong>AceConfigCmd:HandleCommand (slashcmd, appName, input)</strong> - </dt> - <dd> - Handle the chat command. - This is usually called from a chat command handler to parse the command input as operations on an aceoptions table.\ - AceConfigCmd uses this function internally when a slash command is registered with <code>:CreateChatCommand</code> - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">slashcmd</span> - The slash command WITHOUT leading slash (only used for error output) - </li> - <li><span class="parameter">appName</span> - The application name as given to <code>:RegisterOptionsTable()</code> - </li> - <li><span class="parameter">input</span> - The commandline input (as given by the WoW handler, i.e. without the command itself) - </li> - </ul> - - - - - <h3>Usage:</h3> - <ul> - <pre class="example"> - MyAddon = LibStub(<span class="string">"AceAddon-3.0"</span>):NewAddon(<span class="string">"MyAddon"</span>, <span class="string">"AceConsole-3.0"</span>) - <span class="comment">-- Use AceConsole-3.0 to register a Chat Command -</span> MyAddon:RegisterChatCommand(<span class="string">"mychat"</span>, <span class="string">"ChatCommand"</span>) - - <span class="comment">-- Show the GUI if no input is supplied, otherwise handle the chat input. -</span> <span class="keyword">function</span> MyAddon:ChatCommand(input) - <span class="comment">-- Assuming "MyOptions" is the appName of a valid options table -</span> <span class="keyword">if</span> <span class="keyword">not</span> input <span class="keyword">or</span> input:trim() == <span class="string">""</span> <span class="keyword">then</span> - LibStub(<span class="string">"AceConfigDialog-3.0"</span>):Open(<span class="string">"MyOptions"</span>) - <span class="keyword">else</span> - LibStub(<span class="string">"AceConfigCmd-3.0"</span>).HandleCommand(MyAddon, <span class="string">"mychat"</span>, <span class="string">"MyOptions"</span>, input) - <span class="keyword">end</span> - <span class="keyword">end</span></pre> - </ul> - -</dd> - <dt> - <a name = "AceConfigCmd:CreateChatCommand"></a> - <strong>AceConfigCmd:CreateChatCommand (slashcmd, appName)</strong> - </dt> - <dd> - Utility function to create a slash command handler. - Also registers tab completion with AceTab - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">slashcmd</span> - The slash command WITHOUT leading slash (only used for error output) - </li> - <li><span class="parameter">appName</span> - The application name as given to <code>:RegisterOptionsTable()</code> - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceConfigCmd:GetChatCommandOptions"></a> - <strong>AceConfigCmd:GetChatCommandOptions (slashcmd)</strong> - </dt> - <dd> - Utility function that returns the options table that belongs to a slashcommand. - Designed to be used for the AceTab interface. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">slashcmd</span> - The slash command WITHOUT leading slash (only used for error output) - </li> - </ul> - - <h3>Returns:</h3> - <ol> - - The options table associated with the slash command (or nil if the slash command was not registered) - </ol> - - - - -</dd> -</dl> - - -</div> <!-- id="content" --> -</div> <!-- id="main" --> -<div id="about"> -<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i> -<i style="float:right;">Last updated 2015-08-25 09:24:20 </i> -</div> <!-- id="about" --> -</div> <!-- id="container" --> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0.html b/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0.html deleted file mode 100644 index 46f1d32..0000000 --- a/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0.html +++ /dev/null @@ -1,236 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SuperVillain UI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> -</head> -<body> - -<div id="container"> - -<div id="product"> - <div id="product_logo"></div> - <div id="product_name"><big><b></b></big></div> - <div id="product_description"></div> -</div> <!-- id="product" --> - - -<div id="main"> - - -<!-- Menu --> - -<div id="navigation"> -<br/> -<h1>SuperVillain UI</h1> - -<ul> - <li><a href="../index.html">Index</a></li> -</ul> - -<h2>Contents</h2> -<ul> -<li><a href="#Functions">Functions</a></li> -</ul> - - -<h2>Libraries</h2> -<ul class="$(kind=='Topics' and '' or 'nowrap'"> - <li><a href="../libraries/aceconfig-3.0.aceconfig-3.0.html">aceconfig-3.0.aceconfig-3.0</a></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0.html">aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0</a></li> - <li><strong>aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0</strong></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0.html">aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0</a></li> - <li><a href="../libraries/acegui-3.0.acegui-3.0.html">acegui-3.0.acegui-3.0</a></li> -</ul> -<h2>Manual</h2> -<ul class="$(kind=='Topics' and '' or 'nowrap'"> - <li><a href="../manual/doc.md.html">doc</a></li> -</ul> - -</div> - -<div id="content"> - -<h1>Module <code>aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0</code></h1> -<p>Selects the specified path in the options window.</p> -<p> The path specified has to match the keys of the groups in the table.</p> - - -<h2><a href="#Functions">Functions</a></h2> -<table class="function_list"> - <tr> - <td class="name" nowrap><a href="#AceConfigDialog:CloseAll">AceConfigDialog:CloseAll ()</a></td> - <td class="summary">Close all open options windows</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceConfigDialog:Close">AceConfigDialog:Close (appName)</a></td> - <td class="summary">Close a specific options window.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceConfigDialog:SetDefaultSize">AceConfigDialog:SetDefaultSize (appName, width, height)</a></td> - <td class="summary">Sets the default size of the options window for a specific application.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceConfigDialog:Open">AceConfigDialog:Open (appName, container, ...)</a></td> - <td class="summary">Open an option window at the specified path (if any).</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceConfigDialog:AddToBlizOptions">AceConfigDialog:AddToBlizOptions (appName, name, parent, ...)</a></td> - <td class="summary">Add an option table into the Blizzard Interface Options panel.</td> - </tr> -</table> - -<br/> -<br/> - - - <h2 class="section-header "><a name="Functions"></a>Functions</h2> - - <dl class="function"> - <dt> - <a name = "AceConfigDialog:CloseAll"></a> - <strong>AceConfigDialog:CloseAll ()</strong> - </dt> - <dd> - Close all open options windows - - - - - - - -</dd> - <dt> - <a name = "AceConfigDialog:Close"></a> - <strong>AceConfigDialog:Close (appName)</strong> - </dt> - <dd> - Close a specific options window. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">appName</span> - The application name as given to <code>:RegisterOptionsTable()</code> - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceConfigDialog:SetDefaultSize"></a> - <strong>AceConfigDialog:SetDefaultSize (appName, width, height)</strong> - </dt> - <dd> - Sets the default size of the options window for a specific application. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">appName</span> - The application name as given to <code>:RegisterOptionsTable()</code> - </li> - <li><span class="parameter">width</span> - The default width - </li> - <li><span class="parameter">height</span> - The default height - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceConfigDialog:Open"></a> - <strong>AceConfigDialog:Open (appName, container, ...)</strong> - </dt> - <dd> - Open an option window at the specified path (if any). - This function can optionally feed the group into a pre-created container - instead of creating a new container frame. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">appName</span> - The application name as given to <code>:RegisterOptionsTable()</code> - </li> - <li><span class="parameter">container</span> - An optional container frame to feed the options into - </li> - <li><span class="parameter">...</span> - The path to open after creating the options window (see <code>:SelectGroup</code> for details) - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceConfigDialog:AddToBlizOptions"></a> - <strong>AceConfigDialog:AddToBlizOptions (appName, name, parent, ...)</strong> - </dt> - <dd> - Add an option table into the Blizzard Interface Options panel. - You can optionally supply a descriptive name to use and a parent frame to use, - as well as a path in the options table.\ - If no name is specified, the appName will be used instead.</p> - -<p> If you specify a proper <code>parent</code> (by name), the interface options will generate a - tree layout. Note that only one level of children is supported, so the parent always - has to be a head-level note.</p> - -<p> This function returns a reference to the container frame registered with the Interface - Options. You can use this reference to open the options with the API function - <code>InterfaceOptionsFrame_OpenToCategory</code>. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">appName</span> - The application name as given to <code>:RegisterOptionsTable()</code> - </li> - <li><span class="parameter">name</span> - A descriptive name to display in the options tree (defaults to appName) - </li> - <li><span class="parameter">parent</span> - The parent to use in the interface options tree. - </li> - <li><span class="parameter">...</span> - The path in the options table to feed into the interface options panel. - </li> - </ul> - - <h3>Returns:</h3> - <ol> - - The reference to the frame registered into the Interface Options. - </ol> - - - - -</dd> -</dl> - - -</div> <!-- id="content" --> -</div> <!-- id="main" --> -<div id="about"> -<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i> -<i style="float:right;">Last updated 2015-08-25 09:24:20 </i> -</div> <!-- id="about" --> -</div> <!-- id="container" --> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0.html b/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0.html deleted file mode 100644 index 052cde2..0000000 --- a/SVUI_!Core/guide/docs/libraries/aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0.html +++ /dev/null @@ -1,224 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SuperVillain UI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> -</head> -<body> - -<div id="container"> - -<div id="product"> - <div id="product_logo"></div> - <div id="product_name"><big><b></b></big></div> - <div id="product_description"></div> -</div> <!-- id="product" --> - - -<div id="main"> - - -<!-- Menu --> - -<div id="navigation"> -<br/> -<h1>SuperVillain UI</h1> - -<ul> - <li><a href="../index.html">Index</a></li> -</ul> - -<h2>Contents</h2> -<ul> -<li><a href="#Functions">Functions</a></li> -</ul> - - -<h2>Libraries</h2> -<ul class="$(kind=='Topics' and '' or 'nowrap'"> - <li><a href="../libraries/aceconfig-3.0.aceconfig-3.0.html">aceconfig-3.0.aceconfig-3.0</a></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0.html">aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0</a></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0.html">aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0</a></li> - <li><strong>aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0</strong></li> - <li><a href="../libraries/acegui-3.0.acegui-3.0.html">acegui-3.0.acegui-3.0</a></li> -</ul> -<h2>Manual</h2> -<ul class="$(kind=='Topics' and '' or 'nowrap'"> - <li><a href="../manual/doc.md.html">doc</a></li> -</ul> - -</div> - -<div id="content"> - -<h1>Module <code>aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0</code></h1> -<p>Validating options table consistency:</p> -<p> -</p> - - -<h2><a href="#Functions">Functions</a></h2> -<table class="function_list"> - <tr> - <td class="name" nowrap><a href="#AceConfigRegistry:ValidateOptionsTable">AceConfigRegistry:ValidateOptionsTable (options, name, errlvl)</a></td> - <td class="summary">Validates basic structure and integrity of an options table \ - Does NOT verify that get/set etc actually exist, since they can be defined at any depth</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceConfigRegistry:NotifyChange">AceConfigRegistry:NotifyChange (appName)</a></td> - <td class="summary">Fires a “ConfigTableChange” callback for those listening in on it, allowing config GUIs to refresh.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceConfigRegistry:RegisterOptionsTable">AceConfigRegistry:RegisterOptionsTable (appName, options, skipValidation)</a></td> - <td class="summary">Register an options table with the config registry.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceConfigRegistry:IterateOptionsTables">AceConfigRegistry:IterateOptionsTables ()</a></td> - <td class="summary">Returns an iterator of [“appName”]=funcref pairs</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceConfigRegistry:GetOptionsTable">AceConfigRegistry:GetOptionsTable (appName, uiType, uiName)</a></td> - <td class="summary">Query the registry for a specific options table.</td> - </tr> -</table> - -<br/> -<br/> - - - <h2 class="section-header "><a name="Functions"></a>Functions</h2> - - <dl class="function"> - <dt> - <a name = "AceConfigRegistry:ValidateOptionsTable"></a> - <strong>AceConfigRegistry:ValidateOptionsTable (options, name, errlvl)</strong> - </dt> - <dd> - Validates basic structure and integrity of an options table \ - Does NOT verify that get/set etc actually exist, since they can be defined at any depth - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">options</span> - The table to be validated - </li> - <li><span class="parameter">name</span> - The name of the table to be validated (shown in any error message) - </li> - <li><span class="parameter">errlvl</span> - (optional number) error level offset, default 0 (=errors point to the function calling :ValidateOptionsTable) - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceConfigRegistry:NotifyChange"></a> - <strong>AceConfigRegistry:NotifyChange (appName)</strong> - </dt> - <dd> - Fires a “ConfigTableChange” callback for those listening in on it, allowing config GUIs to refresh. - You should call this function if your options table changed from any outside event, like a game event - or a timer. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">appName</span> - The application name as given to <code>:RegisterOptionsTable()</code> - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceConfigRegistry:RegisterOptionsTable"></a> - <strong>AceConfigRegistry:RegisterOptionsTable (appName, options, skipValidation)</strong> - </dt> - <dd> - Register an options table with the config registry. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">appName</span> - The application name as given to <code>:RegisterOptionsTable()</code> - </li> - <li><span class="parameter">options</span> - The options table, OR a function reference that generates it on demand. \ - See the top of the page for info on arguments passed to such functions. - </li> - <li><span class="parameter">skipValidation</span> - Skip options table validation (primarily useful for extremely huge options, with a noticeable slowdown) - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceConfigRegistry:IterateOptionsTables"></a> - <strong>AceConfigRegistry:IterateOptionsTables ()</strong> - </dt> - <dd> - Returns an iterator of [“appName”]=funcref pairs - - - - - - - -</dd> - <dt> - <a name = "AceConfigRegistry:GetOptionsTable"></a> - <strong>AceConfigRegistry:GetOptionsTable (appName, uiType, uiName)</strong> - </dt> - <dd> - Query the registry for a specific options table. - If only appName is given, a function is returned which you - can call with (uiType,uiName) to get the table.\ - If uiType&uiName are given, the table is returned. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">appName</span> - The application name as given to <code>:RegisterOptionsTable()</code> - </li> - <li><span class="parameter">uiType</span> - The type of UI to get the table for, one of “cmd”, “dropdown”, “dialog” - </li> - <li><span class="parameter">uiName</span> - The name of the library/addon querying for the table, e.g. “MyLib-1.0” - </li> - </ul> - - - - - -</dd> -</dl> - - -</div> <!-- id="content" --> -</div> <!-- id="main" --> -<div id="about"> -<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i> -<i style="float:right;">Last updated 2015-08-25 09:24:20 </i> -</div> <!-- id="about" --> -</div> <!-- id="container" --> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/libraries/acegui-3.0.acegui-3.0.html b/SVUI_!Core/guide/docs/libraries/acegui-3.0.acegui-3.0.html deleted file mode 100644 index da02bb2..0000000 --- a/SVUI_!Core/guide/docs/libraries/acegui-3.0.acegui-3.0.html +++ /dev/null @@ -1,391 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SuperVillain UI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> -</head> -<body> - -<div id="container"> - -<div id="product"> - <div id="product_logo"></div> - <div id="product_name"><big><b></b></big></div> - <div id="product_description"></div> -</div> <!-- id="product" --> - - -<div id="main"> - - -<!-- Menu --> - -<div id="navigation"> -<br/> -<h1>SuperVillain UI</h1> - -<ul> - <li><a href="../index.html">Index</a></li> -</ul> - -<h2>Contents</h2> -<ul> -<li><a href="#Functions">Functions</a></li> -</ul> - - -<h2>Libraries</h2> -<ul class="$(kind=='Topics' and '' or 'nowrap'"> - <li><a href="../libraries/aceconfig-3.0.aceconfig-3.0.html">aceconfig-3.0.aceconfig-3.0</a></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0.html">aceconfig-3.0.aceconfigcmd-3.0.aceconfigcmd-3.0</a></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0.html">aceconfig-3.0.aceconfigdialog-3.0.aceconfigdialog-3.0</a></li> - <li><a href="../libraries/aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0.html">aceconfig-3.0.aceconfigregistry-3.0.aceconfigregistry-3.0</a></li> - <li><strong>acegui-3.0.acegui-3.0</strong></li> -</ul> -<h2>Manual</h2> -<ul class="$(kind=='Topics' and '' or 'nowrap'"> - <li><a href="../manual/doc.md.html">doc</a></li> -</ul> - -</div> - -<div id="content"> - -<h1>Module <code>acegui-3.0.acegui-3.0</code></h1> -<p>API Functions —</p> -<p> -</p> - - -<h2><a href="#Functions">Functions</a></h2> -<table class="function_list"> - <tr> - <td class="name" nowrap><a href="#AceGUI:Create">AceGUI:Create (type)</a></td> - <td class="summary">Create a new Widget of the given type.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceGUI:Release">AceGUI:Release (widget)</a></td> - <td class="summary">Releases a widget Object.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceGUI:SetFocus">AceGUI:SetFocus (widget)</a></td> - <td class="summary">Called when a widget has taken focus.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceGUI:ClearFocus">AceGUI:ClearFocus ()</a></td> - <td class="summary">Called when something has happened that could cause widgets with focus to drop it - e.g.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceGUI:RegisterAsContainer">AceGUI:RegisterAsContainer (widget)</a></td> - <td class="summary">Register a widget-class as a container for newly created widgets.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceGUI:RegisterAsWidget">AceGUI:RegisterAsWidget (widget)</a></td> - <td class="summary">Register a widget-class as a widget.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceGUI:RegisterWidgetType">AceGUI:RegisterWidgetType (Name, Constructor, Version)</a></td> - <td class="summary">Registers a widget Constructor, this function returns a new instance of the Widget</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceGUI:RegisterLayout">AceGUI:RegisterLayout (Name, LayoutFunc)</a></td> - <td class="summary">Registers a Layout Function</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceGUI:GetLayout">AceGUI:GetLayout (Name)</a></td> - <td class="summary">Get a Layout Function from the registry</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceGUI:GetNextWidgetNum">AceGUI:GetNextWidgetNum (type)</a></td> - <td class="summary">A type-based counter to count the number of widgets created.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceGUI:GetWidgetCount">AceGUI:GetWidgetCount (type)</a></td> - <td class="summary">Return the number of created widgets for this type.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#AceGUI:GetWidgetVersion">AceGUI:GetWidgetVersion (type)</a></td> - <td class="summary">Return the version of the currently registered widget type.</td> - </tr> -</table> - -<br/> -<br/> - - - <h2 class="section-header "><a name="Functions"></a>Functions</h2> - - <dl class="function"> - <dt> - <a name = "AceGUI:Create"></a> - <strong>AceGUI:Create (type)</strong> - </dt> - <dd> - Create a new Widget of the given type. - This function will instantiate a new widget (or use one from the widget pool), and call the - OnAcquire function on it, before returning. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">type</span> - The type of the widget. - </li> - </ul> - - <h3>Returns:</h3> - <ol> - - The newly created widget. - </ol> - - - - -</dd> - <dt> - <a name = "AceGUI:Release"></a> - <strong>AceGUI:Release (widget)</strong> - </dt> - <dd> - Releases a widget Object. - This function calls OnRelease on the widget and places it back in the widget pool. - Any data on the widget is being erased, and the widget will be hidden.\ - If this widget is a Container-Widget, all of its Child-Widgets will be releases as well. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">widget</span> - The widget to release - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceGUI:SetFocus"></a> - <strong>AceGUI:SetFocus (widget)</strong> - </dt> - <dd> - Called when a widget has taken focus. - e.g. Dropdowns opening, Editboxes gaining kb focus - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">widget</span> - The widget that should be focused - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceGUI:ClearFocus"></a> - <strong>AceGUI:ClearFocus ()</strong> - </dt> - <dd> - Called when something has happened that could cause widgets with focus to drop it - e.g. titlebar of a frame being clicked - - - - - - - -</dd> - <dt> - <a name = "AceGUI:RegisterAsContainer"></a> - <strong>AceGUI:RegisterAsContainer (widget)</strong> - </dt> - <dd> - Register a widget-class as a container for newly created widgets. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">widget</span> - The widget class - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceGUI:RegisterAsWidget"></a> - <strong>AceGUI:RegisterAsWidget (widget)</strong> - </dt> - <dd> - Register a widget-class as a widget. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">widget</span> - The widget class - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceGUI:RegisterWidgetType"></a> - <strong>AceGUI:RegisterWidgetType (Name, Constructor, Version)</strong> - </dt> - <dd> - Registers a widget Constructor, this function returns a new instance of the Widget - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">Name</span> - The name of the widget - </li> - <li><span class="parameter">Constructor</span> - The widget constructor function - </li> - <li><span class="parameter">Version</span> - The version of the widget - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceGUI:RegisterLayout"></a> - <strong>AceGUI:RegisterLayout (Name, LayoutFunc)</strong> - </dt> - <dd> - Registers a Layout Function - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">Name</span> - The name of the layout - </li> - <li><span class="parameter">LayoutFunc</span> - Reference to the layout function - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceGUI:GetLayout"></a> - <strong>AceGUI:GetLayout (Name)</strong> - </dt> - <dd> - Get a Layout Function from the registry - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">Name</span> - The name of the layout - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceGUI:GetNextWidgetNum"></a> - <strong>AceGUI:GetNextWidgetNum (type)</strong> - </dt> - <dd> - A type-based counter to count the number of widgets created. - This is used by widgets that require a named frame, e.g. when a Blizzard - Template requires it. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">type</span> - The widget type - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceGUI:GetWidgetCount"></a> - <strong>AceGUI:GetWidgetCount (type)</strong> - </dt> - <dd> - Return the number of created widgets for this type. - In contrast to GetNextWidgetNum, the number is not incremented. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">type</span> - The widget type - </li> - </ul> - - - - - -</dd> - <dt> - <a name = "AceGUI:GetWidgetVersion"></a> - <strong>AceGUI:GetWidgetVersion (type)</strong> - </dt> - <dd> - Return the version of the currently registered widget type. - - - <h3>Parameters:</h3> - <ul> - <li><span class="parameter">type</span> - The widget type - </li> - </ul> - - - - - -</dd> -</dl> - - -</div> <!-- id="content" --> -</div> <!-- id="main" --> -<div id="about"> -<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i> -<i style="float:right;">Last updated 2015-08-25 09:24:20 </i> -</div> <!-- id="about" --> -</div> <!-- id="container" --> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/libraries/core.html b/SVUI_!Core/guide/docs/libraries/core.html deleted file mode 100644 index efa5888..0000000 --- a/SVUI_!Core/guide/docs/libraries/core.html +++ /dev/null @@ -1,117 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SVUI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> - <!-- Fonts --> - <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> -</head> -<body id="page-top" data-spy="scroll" data-target=".layout-header"> -<div class="skinned-page"></div> -<div id="message-depot"></div> -<!-- BEGIN LAYOUT --> -<div class="layout js-layout js-skins layout-overlay-drawer-button layout-shadow layout-fixed-header layout-fixed-drawer"> - - -<!-- BEGIN NAV // --> - <div class="layout-header"> - <div class="layout-header-row"> - <span class="layout-title">Documentation</span> - <div class="layout-spacer"></div> - <nav class="navigation"> - </nav> - </div> - </div> - - <div class="layout-drawer"> - <span class="navigation-title" style="padding:">Contents</span> - <nav class="navigation" style="padding-top:0 !important;"> - <div class="navigation-subtitle">Libraries</div> - <a href="../index.html" class="navigation-link current-link">core</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Manual</div> - <a href="../manual/doc.md.html" class="navigation-link">doc</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Source</div> - <a href="../source/Librarian.html" class="navigation-link">Librarian</a> - <a href="../source/LUA.html" class="navigation-link">LUA</a> - <a href="../source/AceVillain.html" class="navigation-link">AceVillain</a> - <div class="navigation-spacer"></div> - </nav> - </div> - - <span class="layout-title floating-title no-desktop">Menu</span> - - <div class="layout-drawer-button"> - <i class="layout-drawer-button-icon menu-icon"></i> - </div> - <!-- END NAV // --> - - <!-- BEGIN CONTENT // --> - <div class="layout-content"> - -<section style="padding:0;"> -<div class="grid"> -<div class="cell cell-12-col"> -<div class="container"> - <div class="comic"> - <div class="card"> - <div class="card-header flex--expand"> - <div class="card-header-title flex--centered"> - <span class="badge" data-badge="Module">core</span> - </div> - </div> - <div class="card-actions flex--expand"> - <div class="card-header-subtitle flex--centered">Global SVUI Object.</div> - </div> - <div class="card-section"> - <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - - - </p> -<h5 class="info-header">Summary:</h5> -<p class="preface"> -</p> - <br /> - <br /> - </div> - </div> - </div> - </div> -</div> -</div> -</div> -</section> -</div> -<!-- END CONTENT --> - -<!-- BEGIN FOOTER // --> -<footer> - <div class="right-section"> - <ul class="link-list"> - <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:16:59</span> - </li> - </ul> - </div> -</footer> -<!-- END FOOTER // --> - -</div> -<!-- END LAYOUT --> - -<!-- Core JavaScript --> -<script src="http://supervillainui.com/js/app.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery-1.11.0.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.easing.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.swipebox.min.js"></script> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/manual/doc.md.html b/SVUI_!Core/guide/docs/manual/doc.md.html index 1fdddac..26b496d 100644 --- a/SVUI_!Core/guide/docs/manual/doc.md.html +++ b/SVUI_!Core/guide/docs/manual/doc.md.html @@ -7,10 +7,6 @@ <link rel="stylesheet" href="../ldoc.css" type="text/css" /> <!-- Fonts --> <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> </head> <body id="page-top" data-spy="scroll" data-target=".layout-header"> <div class="skinned-page"></div> @@ -32,17 +28,17 @@ <div class="layout-drawer"> <span class="navigation-title" style="padding:">Contents</span> <nav class="navigation" style="padding-top:0 !important;"> - <div class="navigation-subtitle">Manual</div> - <a href="../manual/doc.md.html" class="navigation-link current-link">doc</a> +<div class="navigation-subtitle">Manual</div> +<a href="../manual/doc.md.html" class="navigation-link current-link">doc</a> <a href="#Introduction" class="navigation-link"> Introduction </a> <a href="#Release_Version" class="navigation-link"> Release Version </a> <a href="#License" class="navigation-link"> License </a> <div class="navigation-spacer"></div> <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Addon</div> - <a href="../index.html" class="navigation-link">SVUI</a> +<div class="navigation-subtitle">Addons</div> + <a href="../index.html" class="navigation-link">SVUI_Core</a> <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Libraries</div> +<div class="navigation-subtitle">Libraries</div> <a href="../libraries/Librarian.html" class="navigation-link">Librarian</a> <a href="../libraries/LUA.html" class="navigation-link">LUA</a> <a href="../libraries/AceVillain.html" class="navigation-link">AceVillain</a> @@ -118,7 +114,7 @@ Copyright © 2010, Munglunch (Steve Jackson). </p> <div class="right-section"> <ul class="link-list"> <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:32:23</span> + <span style="color:#5fafff">Last updated 2015-08-26 14:32:22</span> </li> </ul> </div> diff --git a/SVUI_!Core/guide/docs/packages/doc.md.html b/SVUI_!Core/guide/docs/packages/doc.md.html deleted file mode 100644 index 86cf45e..0000000 --- a/SVUI_!Core/guide/docs/packages/doc.md.html +++ /dev/null @@ -1,136 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SVUI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> - <!-- Fonts --> - <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> -</head> -<body id="page-top" data-spy="scroll" data-target=".layout-header"> -<div class="skinned-page"></div> -<div id="message-depot"></div> -<!-- BEGIN LAYOUT --> -<div class="layout js-layout js-skins layout-overlay-drawer-button layout-shadow layout-fixed-header layout-fixed-drawer"> - - -<!-- BEGIN NAV // --> - <div class="layout-header"> - <div class="layout-header-row"> - <span class="layout-title">Documentation</span> - <div class="layout-spacer"></div> - <nav class="navigation"> - </nav> - </div> - </div> - - <div class="layout-drawer"> - <span class="navigation-title" style="padding:">Contents</span> - <nav class="navigation" style="padding-top:0 !important;"> -<a href="#Introduction" class="navigation-link">Introduction </a> -<a href="#Release_Version" class="navigation-link">Release Version </a> -<a href="#License" class="navigation-link">License </a> - <div class="navigation-subtitle">Packages</div> - <a href="../packages/doc.md.html" class="navigation-link current-link">doc</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Addon</div> - <a href="../index.html" class="navigation-link">SVUI</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Libraries</div> - <a href="../libraries/Librarian.html" class="navigation-link">Librarian</a> - <a href="../libraries/LUA.html" class="navigation-link">LUA</a> - <a href="../libraries/AceVillain.html" class="navigation-link">AceVillain</a> - <div class="navigation-spacer"></div> - </nav> - </div> - - <span class="layout-title floating-title no-desktop">Menu</span> - - <div class="layout-drawer-button"> - <i class="layout-drawer-button-icon menu-icon"></i> - </div> - <!-- END NAV // --> - - <!-- BEGIN CONTENT // --> - <div class="layout-content"> - -<section style="padding:0;"> -<div class="grid"> -<div class="cell cell-12-col"> -<div class="container"> - <div class="comic"> - <div class="card"> - <div class="card-section"> - <div class="section-dialog"> - <h1>SuperVillain UI</h1> - -<p><a name="Introduction"></a></p> - -<h2>Introduction</h2> - -<p>Custom World of Warcraft User Interface</p> - -<h3>Compatibility</h3> - -<p>SuperVillain UI is designed to work with the latest live expansion of World of Warcraft.</p> - -<h3>Notes</h3> - -<ul> -<li>This repo will be used exclusively for development versions</li> -<li>All feature requests will be considered but not guranteed</li> -<li>Please be thorough when posting issues</li> -</ul> - - -<p><a name="Release_Version"></a></p> - -<h2>Release Version</h2> - -<p>If you are looking for the most current release version (non-development) you can find it at <a href="http://www.wowinterface.com/downloads/info23519-SuperVillainUI.html#info">WowInterface</a> or <a href="http://www.curse.com/addons/wow/supervillain-ui">Curse</a></p> - -<p><a name="License"></a></p> - -<h2>License</h2> - -<p>SuperVillain UI is licensed under the The MIT License. -Copyright © 2010, Munglunch (Steve Jackson). </p> - - </div> - </div> - </div> - </div> -</div> -</div> -</div> -</section> -</div> -<!-- END CONTENT --> - -<!-- BEGIN FOOTER // --> -<footer> - <div class="right-section"> - <ul class="link-list"> - <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:23:42</span> - </li> - </ul> - </div> -</footer> -<!-- END FOOTER // --> - -</div> -<!-- END LAYOUT --> - -<!-- Core JavaScript --> -<script src="http://supervillainui.com/js/app.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery-1.11.0.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.easing.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.swipebox.min.js"></script> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/source/AceVillain-1.0.html b/SVUI_!Core/guide/docs/source/AceVillain-1.0.html deleted file mode 100644 index 76377df..0000000 --- a/SVUI_!Core/guide/docs/source/AceVillain-1.0.html +++ /dev/null @@ -1,123 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SVUI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> - <!-- Fonts --> - <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> -</head> -<body id="page-top" data-spy="scroll" data-target=".layout-header"> -<div class="skinned-page"></div> -<div id="message-depot"></div> -<!-- BEGIN LAYOUT --> -<div class="layout js-layout js-skins layout-overlay-drawer-button layout-shadow layout-fixed-header layout-fixed-drawer"> - - -<!-- BEGIN NAV // --> - <div class="layout-header"> - <div class="layout-header-row"> - <span class="layout-title">Documentation</span> - <div class="layout-spacer"></div> - <nav class="navigation"> -<a href="../index.html" class="navigation-link">Index</a> - </nav> - </div> - </div> - - <div class="layout-drawer"> - <span class="navigation-title" style="padding:">Contents</span> - <nav class="navigation" style="padding-top:0 !important;"> -<a href="../index.html" class="navigation-link">Index</a> - <div class="navigation-subtitle">Source</div> - <a href="../source/Librarian.html" class="navigation-link">Librarian</a> - <a href="../source/LUA.html" class="navigation-link">LUA</a> - <a href="../source/AceVillain-1.0.html" class="navigation-link current-link">AceVillain-1.0</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Manual</div> - <a href="../manual/doc.md.html" class="navigation-link">doc</a> - <div class="navigation-spacer"></div> - </nav> - </div> - - <span class="layout-title floating-title no-desktop">Menu</span> - - <div class="layout-drawer-button"> - <i class="layout-drawer-button-icon menu-icon"></i> - </div> - <!-- END NAV // --> - - <!-- BEGIN CONTENT // --> - <div class="layout-content"> - -<section style="padding:0;"> -<div class="grid"> -<div class="cell cell-12-col"> -<div class="container"> - <div class="comic"> - <div class="card"> - <div class="card-header flex--expand"> - <div class="card-header-title flex--centered"> - <span class="badge" data-badge="File">AceVillain-1.0</span> - </div> - </div> - <div class="card-actions flex--expand"> - <div class="card-header-subtitle flex--centered">Ace3 modification library.</div> - </div> - <div class="card-section"> - <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - - - </p> - <h5 class="info-header">Info:</h5> - <p class="preface"> - <ul> - <li><strong>Release</strong>: 1.0.0</li> - <li><strong>Author</strong>: Steven Jackson (2014)</li> - </ul> - </p> -<h5 class="info-header">Summary:</h5> -<p class="preface"> -</p> - <br /> - <br /> - </div> - </div> - </div> - </div> -</div> -</div> -</div> -</section> -</div> -<!-- END CONTENT --> - -<!-- BEGIN FOOTER // --> -<footer> - <div class="right-section"> - <ul class="link-list"> - <li> - <span style="color:#5fafff">Last updated 2015-08-25 14:23:06</span> - </li> - </ul> - </div> -</footer> -<!-- END FOOTER // --> - -</div> -<!-- END LAYOUT --> - -<!-- Core JavaScript --> -<script src="http://supervillainui.com/js/app.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery-1.11.0.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.easing.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.swipebox.min.js"></script> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/source/AceVillain.html b/SVUI_!Core/guide/docs/source/AceVillain.html deleted file mode 100644 index d10d96a..0000000 --- a/SVUI_!Core/guide/docs/source/AceVillain.html +++ /dev/null @@ -1,124 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SVUI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> - <!-- Fonts --> - <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> -</head> -<body id="page-top" data-spy="scroll" data-target=".layout-header"> -<div class="skinned-page"></div> -<div id="message-depot"></div> -<!-- BEGIN LAYOUT --> -<div class="layout js-layout js-skins layout-overlay-drawer-button layout-shadow layout-fixed-header layout-fixed-drawer"> - - -<!-- BEGIN NAV // --> - <div class="layout-header"> - <div class="layout-header-row"> - <span class="layout-title">Documentation</span> - <div class="layout-spacer"></div> - <nav class="navigation"> - </nav> - </div> - </div> - - <div class="layout-drawer"> - <span class="navigation-title" style="padding:">Contents</span> - <nav class="navigation" style="padding-top:0 !important;"> - <div class="navigation-subtitle">Source</div> - <a href="../source/Librarian.html" class="navigation-link">Librarian</a> - <a href="../source/LUA.html" class="navigation-link">LUA</a> - <a href="../source/AceVillain.html" class="navigation-link current-link">AceVillain</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Libraries</div> - <a href="../index.html" class="navigation-link">SVUI</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Manual</div> - <a href="../manual/doc.md.html" class="navigation-link">doc</a> - <div class="navigation-spacer"></div> - </nav> - </div> - - <span class="layout-title floating-title no-desktop">Menu</span> - - <div class="layout-drawer-button"> - <i class="layout-drawer-button-icon menu-icon"></i> - </div> - <!-- END NAV // --> - - <!-- BEGIN CONTENT // --> - <div class="layout-content"> - -<section style="padding:0;"> -<div class="grid"> -<div class="cell cell-12-col"> -<div class="container"> - <div class="comic"> - <div class="card"> - <div class="card-header flex--expand"> - <div class="card-header-title flex--centered"> - <span class="badge" data-badge="File">AceVillain</span> - </div> - </div> - <div class="card-actions flex--expand"> - <div class="card-header-subtitle flex--centered">Ace3 modification library.</div> - </div> - <div class="card-section"> - <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - - - </p> - <h5 class="info-header">Info:</h5> - <p class="preface"> - <ul> - <li><strong>Release</strong>: 1.0.0</li> - <li><strong>Author</strong>: Steven Jackson (2014)</li> - </ul> - </p> -<h5 class="info-header">Summary:</h5> -<p class="preface"> -</p> - <br /> - <br /> - </div> - </div> - </div> - </div> -</div> -</div> -</div> -</section> -</div> -<!-- END CONTENT --> - -<!-- BEGIN FOOTER // --> -<footer> - <div class="right-section"> - <ul class="link-list"> - <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:19:24</span> - </li> - </ul> - </div> -</footer> -<!-- END FOOTER // --> - -</div> -<!-- END LAYOUT --> - -<!-- Core JavaScript --> -<script src="http://supervillainui.com/js/app.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery-1.11.0.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.easing.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.swipebox.min.js"></script> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/source/LUA.html b/SVUI_!Core/guide/docs/source/LUA.html deleted file mode 100644 index 9c2e405..0000000 --- a/SVUI_!Core/guide/docs/source/LUA.html +++ /dev/null @@ -1,440 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SVUI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> - <!-- Fonts --> - <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> -</head> -<body id="page-top" data-spy="scroll" data-target=".layout-header"> -<div class="skinned-page"></div> -<div id="message-depot"></div> -<!-- BEGIN LAYOUT --> -<div class="layout js-layout js-skins layout-overlay-drawer-button layout-shadow layout-fixed-header layout-fixed-drawer"> - - -<!-- BEGIN NAV // --> - <div class="layout-header"> - <div class="layout-header-row"> - <span class="layout-title">Documentation</span> - <div class="layout-spacer"></div> - <nav class="navigation"> - </nav> - </div> - </div> - - <div class="layout-drawer"> - <span class="navigation-title" style="padding:">Contents</span> - <nav class="navigation" style="padding-top:0 !important;"> -<a href="#Math" class="navigation-link">Math </a> -<a href="#Pickle" class="navigation-link">Pickle </a> -<a href="#String" class="navigation-link">String </a> -<a href="#Table" class="navigation-link">Table </a> - <div class="navigation-subtitle">Source</div> - <a href="../source/Librarian.html" class="navigation-link">Librarian</a> - <a href="../source/LUA.html" class="navigation-link current-link">LUA</a> - <a href="../source/AceVillain.html" class="navigation-link">AceVillain</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Libraries</div> - <a href="../index.html" class="navigation-link">SVUI</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Manual</div> - <a href="../manual/doc.md.html" class="navigation-link">doc</a> - <div class="navigation-spacer"></div> - </nav> - </div> - - <span class="layout-title floating-title no-desktop">Menu</span> - - <div class="layout-drawer-button"> - <i class="layout-drawer-button-icon menu-icon"></i> - </div> - <!-- END NAV // --> - - <!-- BEGIN CONTENT // --> - <div class="layout-content"> - -<section style="padding:0;"> -<div class="grid"> -<div class="cell cell-12-col"> -<div class="container"> - <div class="comic"> - <div class="card"> - <div class="card-header flex--expand"> - <div class="card-header-title flex--centered"> - <span class="badge" data-badge="File">LUA</span> - </div> - </div> - <div class="card-actions flex--expand"> - <div class="card-header-subtitle flex--centered">LUA companion library.</div> - </div> - <div class="card-section"> - <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - - - </p> - <h5 class="info-header">Info:</h5> - <p class="preface"> - <ul> - <li><strong>Release</strong>: 1.0.0</li> - <li><strong>Author</strong>: Steven Jackson (2014)</li> - </ul> - </p> -<h5 class="info-header">Summary:</h5> -<p class="preface"> - <div style="padding:6px 0px;"><a href="#Math" style="color:#ff5500">Jump To: Math ⋙</a></div> - <table class="function_list"> - <tr> - <td class="name" nowrap><a href="#math.parsefloat">math.parsefloat (value, decimal)</a></td> - <td class="summary">Integer float utility for lua.</td> - </tr> - </table> - <div style="padding:6px 0px;"><a href="#Pickle" style="color:#ff5500">Jump To: Pickle ⋙</a></div> - <table class="function_list"> - <tr> - <td class="name" nowrap><a href="#Pickle">Pickle</a></td> - <td class="summary">Global class used by pickle/unpickle functions.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#pickle">pickle (t)</a></td> - <td class="summary">A table serialization utility for lua.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#unpickle">unpickle (s)</a></td> - <td class="summary">Un-serialization tool (pretty sure thats not a word).</td> - </tr> - </table> - <div style="padding:6px 0px;"><a href="#String" style="color:#ff5500">Jump To: String ⋙</a></div> - <table class="function_list"> - <tr> - <td class="name" nowrap><a href="#string.encode">string.encode (data)</a></td> - <td class="summary">Base64 encoding tool.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#string.decode">string.decode (data)</a></td> - <td class="summary">Base64 decoding tool.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#string.explode">string.explode (data, delim)</a></td> - <td class="summary">String to array utility.</td> - </tr> - </table> - <div style="padding:6px 0px;"><a href="#Table" style="color:#ff5500">Jump To: Table ⋙</a></div> - <table class="function_list"> - <tr> - <td class="name" nowrap><a href="#table.tostring">table.tostring (tbl, pretty)</a></td> - <td class="summary">Dump table contents to string</td> - </tr> - <tr> - <td class="name" nowrap><a href="#table.copy">table.copy (targetTable, deepCopy, mergeTable)</a></td> - <td class="summary">Copy all table data from a source to another table</td> - </tr> - </table> -</p> - <br /> - <br /> - <h4 class="section-header has-description"><a name="Math"></a>Math </h4> - - <div class="section-description"> - UTILITIES - </div> - <dl class="function"> - <dt id="math.parsefloat"> - <strong>math.parsefloat (value, decimal)</strong> - </dt> - <dd> - Integer float utility for lua. - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>value</strong><td> - The integer amount to be adjusted. - </td></tr> - <tr><td style="width:20% !important;"><strong>decimal</strong><td> - Number of decimal places allowed. - </td></tr> -</tbody></table> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> - <ol> - - floating point integer - </ol> - - - - - </dd> - </dl> - <h4 class="section-header has-description"><a name="Pickle"></a>Pickle </h4> - - <div class="section-description"> - UTILITIES - </div> - <dl class="function"> - <dt id="Pickle"> - <strong>Pickle</strong> - </dt> - <dd> - Global class used by pickle/unpickle functions. - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Fields:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>clone</strong><td> - - - </td></tr> -</tbody></table> - - - - - - </dd> - <dt id="pickle"> - <strong>pickle (t)</strong> - </dt> - <dd> - A table serialization utility for lua. - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>t</strong><td> - A table to be serialized. - </td></tr> -</tbody></table> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> - <ol> - - serialized table data - </ol> - - - - - </dd> - <dt id="unpickle"> - <strong>unpickle (s)</strong> - </dt> - <dd> - Un-serialization tool (pretty sure thats not a word). - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>s</strong><td> - A serialized table to be reversed. - </td></tr> -</tbody></table> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> - <ol> - - serialized table data - </ol> - - - - - </dd> - </dl> - <h4 class="section-header has-description"><a name="String"></a>String </h4> - - <div class="section-description"> - UTILITIES - </div> - <dl class="function"> - <dt id="string.encode"> - <strong>string.encode (data)</strong> - </dt> - <dd> - Base64 encoding tool. - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>data</strong><td> - string data to be encoded. - </td></tr> -</tbody></table> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> - <ol> - - encoded string - </ol> - - - - - </dd> - <dt id="string.decode"> - <strong>string.decode (data)</strong> - </dt> - <dd> - Base64 decoding tool. - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>data</strong><td> - encoded string to be decoded. - </td></tr> -</tbody></table> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> - <ol> - - decoded string - </ol> - - - - - </dd> - <dt id="string.explode"> - <strong>string.explode (data, delim)</strong> - </dt> - <dd> - String to array utility. - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>data</strong><td> - string to be converted to table data. - </td></tr> - <tr><td style="width:20% !important;"><strong>delim</strong><td> - Character delimiter to separate the string by. - </td></tr> -</tbody></table> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> - <ol> - - table data - </ol> - - - - - </dd> - </dl> - <h4 class="section-header has-description"><a name="Table"></a>Table </h4> - - <div class="section-description"> - UTILITIES - </div> - <dl class="function"> - <dt id="table.tostring"> - <strong>table.tostring (tbl, pretty)</strong> - </dt> - <dd> - Dump table contents to string - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>tbl</strong><td> - A table to be stringified. - </td></tr> - <tr><td style="width:20% !important;"><strong>pretty</strong><td> - Flag to syntactically format the result. - </td></tr> -</tbody></table> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> - <ol> - - string value - </ol> - - - - - </dd> - <dt id="table.copy"> - <strong>table.copy (targetTable, deepCopy, mergeTable)</strong> - </dt> - <dd> - Copy all table data from a source to another table - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>targetTable</strong><td> - The recipient of the copied data. - </td></tr> - <tr><td style="width:20% !important;"><strong>deepCopy</strong><td> - Flag the use of DEEP copying. - </td></tr> - <tr><td style="width:20% !important;"><strong>mergeTable</strong><td> - The origin of the copied data. - </td></tr> -</tbody></table> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> - <ol> - - copied data - </ol> - - - - - </dd> - </dl> - </div> - </div> - </div> - </div> -</div> -</div> -</div> -</section> -</div> -<!-- END CONTENT --> - -<!-- BEGIN FOOTER // --> -<footer> - <div class="right-section"> - <ul class="link-list"> - <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:19:24</span> - </li> - </ul> - </div> -</footer> -<!-- END FOOTER // --> - -</div> -<!-- END LAYOUT --> - -<!-- Core JavaScript --> -<script src="http://supervillainui.com/js/app.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery-1.11.0.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.easing.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.swipebox.min.js"></script> -</body> -</html> diff --git a/SVUI_!Core/guide/docs/source/Librarian.html b/SVUI_!Core/guide/docs/source/Librarian.html deleted file mode 100644 index c606de8..0000000 --- a/SVUI_!Core/guide/docs/source/Librarian.html +++ /dev/null @@ -1,225 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>SVUI Guide</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> - <!-- Fonts --> - <link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css"> - <style> - .info-header{border-top:1px solid rgba(0,0,0,0.12);} - .card-header{padding:0 !important;} - </style> -</head> -<body id="page-top" data-spy="scroll" data-target=".layout-header"> -<div class="skinned-page"></div> -<div id="message-depot"></div> -<!-- BEGIN LAYOUT --> -<div class="layout js-layout js-skins layout-overlay-drawer-button layout-shadow layout-fixed-header layout-fixed-drawer"> - - -<!-- BEGIN NAV // --> - <div class="layout-header"> - <div class="layout-header-row"> - <span class="layout-title">Documentation</span> - <div class="layout-spacer"></div> - <nav class="navigation"> - </nav> - </div> - </div> - - <div class="layout-drawer"> - <span class="navigation-title" style="padding:">Contents</span> - <nav class="navigation" style="padding-top:0 !important;"> -<a href="#Functions" class="navigation-link">Functions</a> -<a href="#Tables" class="navigation-link">Tables</a> - <div class="navigation-subtitle">Source</div> - <a href="../source/Librarian.html" class="navigation-link current-link">Librarian</a> - <a href="../source/LUA.html" class="navigation-link">LUA</a> - <a href="../source/AceVillain.html" class="navigation-link">AceVillain</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Libraries</div> - <a href="../index.html" class="navigation-link">SVUI</a> - <div class="navigation-spacer"></div> - <div class="navigation-subtitle">Manual</div> - <a href="../manual/doc.md.html" class="navigation-link">doc</a> - <div class="navigation-spacer"></div> - </nav> - </div> - - <span class="layout-title floating-title no-desktop">Menu</span> - - <div class="layout-drawer-button"> - <i class="layout-drawer-button-icon menu-icon"></i> - </div> - <!-- END NAV // --> - - <!-- BEGIN CONTENT // --> - <div class="layout-content"> - -<section style="padding:0;"> -<div class="grid"> -<div class="cell cell-12-col"> -<div class="container"> - <div class="comic"> - <div class="card"> - <div class="card-header flex--expand"> - <div class="card-header-title flex--centered"> - <span class="badge" data-badge="File">Librarian</span> - </div> - </div> - <div class="card-actions flex--expand"> - <div class="card-header-subtitle flex--centered">Librarian lib management library.</div> - </div> - <div class="card-section"> - <div class="section-dialog"> - <h5 class="info-header">Description:</h5> - <p> - Librarian is a versioning manager for use with proprietary SVUI libraries. - </p> - <h5 class="info-header">Info:</h5> - <p class="preface"> - <ul> - <li><strong>Release</strong>: 1.0.0</li> - <li><strong>Author</strong>: Steven Jackson (2014)</li> - </ul> - </p> -<h5 class="info-header">Summary:</h5> -<p class="preface"> - <div style="padding:6px 0px;"><a href="#Functions" style="color:#ff5500">Jump To: Functions⋙</a></div> - <table class="function_list"> - <tr> - <td class="name" nowrap><a href="#NewLibrary">NewLibrary (libName)</a></td> - <td class="summary">Adds a new lib to saved objects.</td> - </tr> - <tr> - <td class="name" nowrap><a href="#Fetch">Fetch (libName, silent)</a></td> - <td class="summary">Retrieve a saved library object.</td> - </tr> - </table> - <div style="padding:6px 0px;"><a href="#Tables" style="color:#ff5500">Jump To: Tables⋙</a></div> - <table class="function_list"> - <tr> - <td class="name" nowrap><a href="#Librarian">Librarian</a></td> - <td class="summary">Global Librarian object.</td> - </tr> - </table> -</p> - <br /> - <br /> - <h4 class="section-header "><a name="Functions"></a>Functions</h4> - - <dl class="function"> - <dt id="NewLibrary"> - <strong>NewLibrary (libName)</strong> - </dt> - <dd> - Adds a new lib to saved objects. - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>libName</strong><td> - hashable name of the new library. - </td></tr> -</tbody></table> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> - <ol> - - Lib class object - </ol> - - - - - </dd> - <dt id="Fetch"> - <strong>Fetch (libName, silent)</strong> - </dt> - <dd> - Retrieve a saved library object. - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>libName</strong><td> - Saved name of the library. - </td></tr> - <tr><td style="width:20% !important;"><strong>silent</strong><td> - do not allow errors to propegate. - </td></tr> -</tbody></table> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div> - <ol> - - Lib class object - </ol> - - - - - </dd> - </dl> - <h4 class="section-header "><a name="Tables"></a>Tables</h4> - - <dl class="function"> - <dt id="Librarian"> - <strong>Librarian</strong> - </dt> - <dd> - Global Librarian object. - <br /> - -<div style="padding:12px 0 6px;font-size:15px;"><strong>Fields:</strong></div> -<table> -<tbody> - <tr><td style="width:20% !important;"><strong>libs</strong><td> - - - </td></tr> -</tbody></table> - - - - - - </dd> - </dl> - </div> - </div> - </div> - </div> -</div> -</div> -</div> -</section> -</div> -<!-- END CONTENT --> - -<!-- BEGIN FOOTER // --> -<footer> - <div class="right-section"> - <ul class="link-list"> - <li> - <span style="color:#5fafff">Last updated 2015-08-25 16:19:24</span> - </li> - </ul> - </div> -</footer> -<!-- END FOOTER // --> - -</div> -<!-- END LAYOUT --> - -<!-- Core JavaScript --> -<script src="http://supervillainui.com/js/app.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery-1.11.0.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.easing.min.js"></script> -<script src="http://supervillainui.com/js/extended/jquery.swipebox.min.js"></script> -</body> -</html> diff --git a/SVUI_!Core/libs/_Librarian/Librarian.lua b/SVUI_!Core/libs/_Librarian/Librarian.lua index b578de8..12303f2 100644 --- a/SVUI_!Core/libs/_Librarian/Librarian.lua +++ b/SVUI_!Core/libs/_Librarian/Librarian.lua @@ -1,11 +1,11 @@ --- Librarian lib management library. -- Librarian is a versioning manager for use with proprietary SVUI libraries. --- @class file --- @name Librarian +-- @file Librarian -- @author Steven Jackson (2014) -- @release 1.0.0 --[[ +@usage Librarian is a library used to manage localization, packages, scripts, animations and data embedded into the SVUI core addon. diff --git a/SVUI_!Core/libs/_SVUI_Lib/Librarian.lua b/SVUI_!Core/libs/_SVUI_Lib/Librarian.lua deleted file mode 100644 index 1a788d7..0000000 --- a/SVUI_!Core/libs/_SVUI_Lib/Librarian.lua +++ /dev/null @@ -1,68 +0,0 @@ ---[[ -Librarian is a library used to manage localization, packages, scripts, animations and data embedded -into the SVUI core addon. - -It's main purpose is to keep all methods and logic needed to properly keep -core add-ins functioning outside of the core object and away from other libraries like LibStub. ---]] -local _G = getfenv(0) -local assert = _G.assert; -local type = _G.type; -local error = _G.error; -local pairs = _G.pairs; -local tostring = _G.tostring; - -local Librarian = _G["Librarian"] - -if not Librarian then - Librarian = Librarian or {libs = {}, arrested = {}, warrants = {}} - _G["Librarian"] = Librarian - - function Librarian:NewLibrary(libName) - assert(type(libName) == "string", "Missing Library Name") - self.libs[libName] = self.libs[libName] or {} - return self.libs[libName] - end - - function Librarian:Fetch(libName, silent) - if not self.libs[libName] and not silent then - error(("Cannot find a library instance of %q."):format(tostring(libName)), 2) - end - return self.libs[libName] - end - - local dead = function() return end - - function Librarian:LockLibrary(lib) - local LibStub = _G.LibStub; - if((self.warrants[lib]) or (not LibStub) or (not LibStub.libs)) then return end - for libName,libObj in pairs(LibStub.libs) do - if(libName:find(lib) and (not self.arrested[libName])) then - self.warrants[lib] = true - self.arrested[libName] = {} - for k,v in pairs(libObj) do - if(type(v) == 'function') then - self.arrested[libName][k] = v - v = dead - end - end - end - end - end - - function Librarian:UnlockLibrary(lib) - local LibStub = _G.LibStub; - if((not LibStub) or (not LibStub.libs)) then return end - for libName,libObj in pairs(LibStub.libs) do - if(libName:find(lib) and (self.arrested[libName])) then - for k,v in pairs(self.arrested[libName]) do - libObj[k] = v - end - self.warrants[lib] = nil - self.arrested[libName] = nil - end - end - end - - setmetatable(Librarian, { __call = Librarian.Fetch }) -end diff --git a/SVUI_!Core/system/core.lua b/SVUI_!Core/system/core.lua index a78e4ce..9686ec2 100644 --- a/SVUI_!Core/system/core.lua +++ b/SVUI_!Core/system/core.lua @@ -1,11 +1,29 @@ --- SVUI is our global addon object. -- SuperVillain UI Core Module. --- @module SVUI +-- @module SVUI_Core -- @author Steven Jackson (2014) -- @release 1.0.0 +-- @usage +-- -- Every other file will set a reference to the addon using this variable. Here is how we set it. +-- +-- -- METHOD 1 ---------------------------------------------------------------- +-- -- if we are setting this inside the core.lua file then use this method +-- local global = "SVUI_Global" -- reference to SavedVariables +-- local errors = "SVUI_Errors" -- reference to SavedVariables +-- local private = "SVUI_Private" -- reference to SavedVariables +-- local media = "SVUI_Media" -- reference to SavedVariables +-- local shared = "SVUI_Shared" -- reference to SavedVariables +-- +-- local Registry = Librarian("Registry") -- now pull down the Registry object +-- -- finally we use the 'NewCore' function specifically for this +-- local SV = Registry:NewCore(global, errors, private, media, shared) +-- +-- -- METHOD 2 ---------------------------------------------------------------- +-- -- if we are setting the variable in any other file then use this method +-- local SV = _G['SVUI'] local _G = _G; ---LUA +---- LUA ---- local unpack = _G.unpack; local select = _G.select; local assert = _G.assert; @@ -22,7 +40,7 @@ local tostring = _G.tostring; local tonumber = _G.tonumber; local getmetatable = _G.getmetatable; local setmetatable = _G.setmetatable; ---STRING +---- STRING ---- local string = _G.string; local split = string.split; local upper = string.upper; @@ -30,23 +48,25 @@ local format = string.format; local find = string.find; local match = string.match; local gsub = string.gsub; ---MATH +---- MATH ---- local math = _G.math; local floor = math.floor local random = math.random; ---TABLE +---- TABLE ---- local table = _G.table; local tsort = table.sort; local tconcat = table.concat; local tremove = _G.tremove; local wipe = _G.wipe; ---BLIZZARD API +---- BLIZZARD API ---- local collectgarbage = _G.collectgarbage; local ERR_NOT_IN_COMBAT = _G.ERR_NOT_IN_COMBAT; local RequestBattlefieldScoreData = _G.RequestBattlefieldScoreData; ---[[ CONSTANTS ]]-- +local SVUILib = Librarian("Registry"); + +---- CONSTANTS ---- _G.BINDING_HEADER_SVUI = "SuperVillain UI"; _G.BINDING_NAME_SVUI_MARKERS = "Raid Markers"; @@ -62,13 +82,8 @@ _G.SLASH_RELOADUI1 = "/rl" _G.SLASH_RELOADUI2 = "/reloadui" _G.SVUI_ICON_COORDS = {0.1, 0.9, 0.1, 0.9}; ---:SetTexCoord(unpack(_G.SVUI_ICON_COORDS)) - ---[[ GET THE REGISTRY LIB ]]-- - -local SVUILib = Librarian("Registry"); ---[[ LOCALS ]]-- +---- LOCALS ---- local rez = GetCVar("gxResolution"); local baseHeight = tonumber(rez:match("%d+x(%d+)")) @@ -82,12 +97,12 @@ local playerRealm = GetRealmName(); local playerClass = select(2, UnitClass("player")); local errorPattern = "|cffff0000Error -- |r|cffff9900Required addon '|r|cffffff00%s|r|cffff9900' is %s.|r"; ---[[ COMMON CONSTANTS ]]-- +---- COMMON CONSTANTS ---- _G.SHOWORHIDE = SHOW .. "\\" .. HIDE; _G.MINIMIZEORMAXIMIZE = MINIMIZE .. "\\" .. WINDOWED_MAXIMIZED; ---[[ BUILD CLASS COLOR GLOBAL, CAN BE OVERRIDDEN BY THE ADDON !ClassColors ]]-- +---- BUILD CLASS COLOR GLOBAL, CAN BE OVERRIDDEN BY THE ADDON !ClassColors ---- local CUSTOM_CLASS_COLORS = _G.CUSTOM_CLASS_COLORS; @@ -143,7 +158,7 @@ if(not CUSTOM_CLASS_COLORS) then ["MONK"] = { r = 0.015, g = 0.886, b = 0.38 }, }; - --[[ IF WE NEED TO FORCE DEFAULT COLORS, USE THIS INSTEAD ]]-- + ---- IF WE NEED TO FORCE DEFAULT COLORS, USE THIS INSTEAD ---- -- local supercolors = { -- ["HUNTER"] = { r = 0.67, g = 0.83, b = 0.45 }, @@ -187,15 +202,10 @@ if(not CUSTOM_CLASS_COLORS) then classes = nil end ---[[ CORE ENGINE CONSTRUCT ]]-- +---- Global SVUI Object. We have to send the names ---- +---- of our three SavedVariables files since the ---- +---- WoW API has no method for parsing them in LUA. ---- --- We have to send the names of our three SavedVariables files since the WoW API --- has no method for parsing them in LUA. - ---------------------------------------------------------------------- --- Global SVUI Object. --- @todo Does this need to be global? ---------------------------------------------------------------------- local SV = SVUILib:NewCore("SVUI_Global", "SVUI_Errors", "SVUI_Private", "SVUI_Media", "SVUI_Shared") SV.ConfigID = "SVUI_!Options"; @@ -225,35 +235,36 @@ SVUILib.CONSTRAINTS.PROTECTED["color"] = true; SVUILib.CONSTRAINTS.PROTECTED["bordercolor"] = true; SVUILib.CONSTRAINTS.PROTECTED["Filters"] = true; + SV.mediadefaults = {}; SV.defaults = { - ["LAYOUT"] = {}, - ["Filters"] = {}, - ["screen"] = { - ["autoScale"] = true, - ["multiMonitor"] = false, - ["advanced"] = false, - ["scaleAdjust"] = 0.64, - ["forcedWidth"] = baseWidth, - ["forcedHeight"] = baseHeight, + LAYOUT = {}, + Filters = {}, + screen = { + autoScale = true, + multiMonitor = false, + advanced = false, + scaleAdjust = 0.64, + forcedWidth = baseWidth, + forcedHeight = baseHeight, }, - ["general"] = { - ["loginmessage"] = true, - ["logincredits"] = true, - ["cooldown"] = true, - ["useDraggable"] = true, - ["saveDraggable"] = false, - ["taintLog"] = false, - ["stickyFrames"] = true, - ["graphSize"] = 50, - ["loot"] = true, - ["lootRoll"] = true, - ["lootRollWidth"] = 328, - ["lootRollHeight"] = 28, - ["filterErrors"] = true, - ["hideErrorFrame"] = true, - ["customClassColor"] = false, - ["errorFilters"] = { + general = { + loginmessage = true, + logincredits = true, + cooldown = true, + useDraggable = true, + saveDraggable = false, + taintLog = false, + stickyFrames = true, + graphSize = 50, + loot = true, + lootRoll = true, + lootRollWidth = 328, + lootRollHeight = 28, + filterErrors = true, + hideErrorFrame = true, + customClassColor = false, + errorFilters = { [INTERRUPTED] = false, [ERR_ABILITY_COOLDOWN] = true, [ERR_ATTACK_CHANNEL] = false, @@ -303,117 +314,117 @@ SV.defaults = { [SPELL_FAILED_UNIT_NOT_INFRONT] = false, } }, - ["Extras"] = { - ["autoRoll"] = false, - ["autoRollDisenchant"] = false, - ["autoRollMaxLevel"] = false, - ["autoRollSoulbound"] = true, - ["autoRollQuality"] = '2', - ["vendorGrays"] = true, - ["autoAcceptInvite"] = false, - ["autorepchange"] = false, - ["pvpautorelease"] = false, - ["autoquestcomplete"] = false, - ["autoquestreward"] = false, - ["autoquestaccept"] = false, - ["autodailyquests"] = false, - ["autopvpquests"] = false, - ["skipcinematics"] = false, - ["mailOpener"] = true, - ["autoRepair"] = "PLAYER", - ["threatbar"] = false, - ["woot"] = true, - ["pvpinterrupt"] = true, - ["lookwhaticando"] = false, - ["reactionChat"] = false, - ["reactionEmote"] = false, - ["sharingiscaring"] = false, - ["arenadrink"] = true, - ["stupidhat"] = true, + Extras = { + autoRoll = false, + autoRollDisenchant = false, + autoRollMaxLevel = false, + autoRollSoulbound = true, + autoRollQuality = '2', + vendorGrays = true, + autoAcceptInvite = false, + autorepchange = false, + pvpautorelease = false, + autoquestcomplete = false, + autoquestreward = false, + autoquestaccept = false, + autodailyquests = false, + autopvpquests = false, + skipcinematics = false, + mailOpener = true, + autoRepair = "PLAYER", + threatbar = false, + woot = true, + pvpinterrupt = true, + lookwhaticando = false, + reactionChat = false, + reactionEmote = false, + sharingiscaring = false, + arenadrink = true, + stupidhat = true, }, - ["Gear"] = { - ["durability"] = { - ["enable"] = true, - ["onlydamaged"] = true, + Gear = { + durability = { + enable = true, + onlydamaged = true, }, - ["labels"] = { - ["characterItemLevel"] = true, - ["inventoryItemLevel"] = true, - ["characterGearSet"] = true, - ["inventoryGearSet"] = true, + labels = { + characterItemLevel = true, + inventoryItemLevel = true, + characterGearSet = true, + inventoryGearSet = true, }, - ["specialization"] = { - ["enable"] = false, - ["primary"] = "none", - ["secondary"] = "none", + specialization = { + enable = false, + primary = "none", + secondary = "none", }, - ["battleground"] = { - ["enable"] = false, - ["primary"] = "none", - ["secondary"] = "none", + battleground = { + enable = false, + primary = "none", + secondary = "none", }, }, - ["FunStuff"] = { - ["drunk"] = true, - ["NPC"] = true, - ["comix"] = '1', - ["comixLastState"] = '1', - ["gamemenu"] = '1', - ["afk"] = '1', + FunStuff = { + drunk = true, + NPC = true, + comix = '1', + comixLastState = '1', + gamemenu = '1', + afk = '1', }, - ["Dock"] = { - ["dockWidth"] = 412, - ["dockHeight"] = 224, - ["dockOpacity"] = 1, - ["backdrop"] = true, - ["dockLeftWidth"] = 412, - ["dockLeftHeight"] = 224, - ["dockRightWidth"] = 412, - ["dockRightHeight"] = 224, - ["dockTopLeftWidth"] = 412, - ["dockTopLeftHeight"] = 224, - ["dockTopRightWidth"] = 412, - ["dockTopRightHeight"] = 224, - ["dockCenterWidth"] = defaultCenterWidth, - ["dockCenterHeight"] = 20, - ["buttonSize"] = 30, - ["buttonSpacing"] = 4, - ["topPanel"] = true, - ["bottomPanel"] = true, - ["dockTools"] = { - ["garrison"] = true, - ["firstAid"] = true, - ["cooking"] = true, - ["archaeology"] = true, - ["primary"] = true, - ["secondary"] = true, - ["hearth"] = true, - ["specswap"] = true, - ["leader"] = true, - ["breakstuff"] = true, - ["power"] = false + Dock = { + dockWidth = 412, + dockHeight = 224, + dockOpacity = 1, + backdrop = true, + dockLeftWidth = 412, + dockLeftHeight = 224, + dockRightWidth = 412, + dockRightHeight = 224, + dockTopLeftWidth = 412, + dockTopLeftHeight = 224, + dockTopRightWidth = 412, + dockTopRightHeight = 224, + dockCenterWidth = defaultCenterWidth, + dockCenterHeight = 20, + buttonSize = 30, + buttonSpacing = 4, + topPanel = true, + bottomPanel = true, + dockTools = { + garrison = true, + firstAid = true, + cooking = true, + archaeology = true, + primary = true, + secondary = true, + hearth = true, + specswap = true, + leader = true, + breakstuff = true, + power = false }, - ["hearthOptions"] = { - ["left"] = 6948, - ["right"] = 110560 + hearthOptions = { + left = 6948, + right = 110560 }, }, - ["REPORT_SLOTS"] = { - ["1"] = { "Experience Bar", "Time", "System" }, - ["2"] = { "Gold", "Friends", "Durability Bar" }, - ["3"] = { "None", "None", "None" }, - ["4"] = { "None", "None", "None" }, + REPORT_SLOTS = { + ['1'] = { "Experience Bar", "Time", "System" }, + ['2'] = { "Gold", "Friends", "Durability Bar" }, + ['3'] = { "None", "None", "None" }, + ['4'] = { "None", "None", "None" }, }, - ["Reports"] = { - ["backdrop"] = false, - ["shortGold"] = true, - ["localtime"] = true, - ["time24"] = false, - ["battleground"] = true, + Reports = { + backdrop = false, + shortGold = true, + localtime = true, + time24 = false, + battleground = true, }, }; ---[[ EMBEDDED LIBS ]]-- +---- EMBEDDED LIBS ---- SV.Options = { type = "group", @@ -462,12 +473,12 @@ local function _tablecopy(d, s) end local function _removedeprecated() - --[[ BEGIN DEPRECATED ]]-- + ---- BEGIN DEPRECATED ---- if(_G.SVUI_Filters and (not _G.SVUI_TRANSFER_WIZARD)) then _tablecopy(SV.db.Filters, _G.SVUI_Filters) _G.SVUI_Filters = nil end - --[[ END DEPRECATED ]]-- + ---- END DEPRECATED ---- end local function _needsupdate(value, lowMajor, lowMinor, lowPatch) @@ -480,12 +491,12 @@ local function _needsupdate(value, lowMajor, lowMinor, lowPatch) version = tostring(version) end if(not version) then - -- print('No Version Found') + ---- print('No Version Found') ---- return true end local vt = version:explode(".") local MAJOR,MINOR,PATCH = unpack(vt) - --print(PATCH)print(type(lowPatch)) + ---- print(PATCH)print(type(lowPatch)) ---- if(PATCH and (lowPatch > 0)) then if(type(PATCH) == "string") then PATCH = tonumber(PATCH) @@ -518,9 +529,12 @@ local function _needsupdate(value, lowMajor, lowMinor, lowPatch) end end ---[[ BUILD LOGIN MESSAGES ]]-- local SetLoginMessage; do + --------------------------------------------------------------------- + -- Messages + -- @section MESSAGES Addon Message Handlers + --------------------------------------------------------------------- local commandments = { { "schemes diabolical", @@ -562,37 +576,86 @@ do local custom_msg = (self.L["LOGIN_MSG"]):format(first, second) _send_message(custom_msg, prefix) local login_msg = (self.L["LOGIN_MSG2"]):format(self.Version) - --local login_msg = (testPattern):format(self.Version, self.GameVersion) + ---- local login_msg = (testPattern):format(self.Version, self.GameVersion) ---- _send_message(login_msg, prefix) end - function SV:SCTMessage(message, r, g, b, displayType) - --/script CombatText_AddMessage("TESTING", COMBAT_TEXT_SCROLL_FUNCTION, 1, 1, 0) + --------------------------------------------------------------------- + -- Send messages to the scrolling message frame (combat text). + -- @function SCTMessage + -- @tparam string message The dialog to be displayed. + -- @param red Text coloring, red value. + -- @param green Text coloring, green value. + -- @param blue Text coloring, blue value. + -- @param displayType Special animation type (STICKY, CRITICAL or nil). + -- @usage SV:SCTMessage('My message', 0.1, 0.2, 0.3, 'STICKY') + --------------------------------------------------------------------- + + function SV:SCTMessage(message, red, green, blue, displayType) + ---- /script CombatText_AddMessage("TESTING", COMBAT_TEXT_SCROLL_FUNCTION, 1, 1, 0) ---- if not _G.CombatText_AddMessage then return end - _G.CombatText_AddMessage(message, COMBAT_TEXT_SCROLL_FUNCTION, r, g, b, displayType) + _G.CombatText_AddMessage(message, COMBAT_TEXT_SCROLL_FUNCTION, red, green, blue, displayType) end - function SV:AddonMessage(msg) + --------------------------------------------------------------------- + -- Send messages to the chat frame prefixed with the addon branding. + -- @function AddonMessage + -- @tparam string message The dialog to be displayed. + --------------------------------------------------------------------- + + function SV:AddonMessage(message) local outbound = (messagePattern):format(self.NameID) - _send_message(msg, outbound) + _send_message(message, outbound) end - function SV:CharacterMessage(msg) + --------------------------------------------------------------------- + -- Send messages to the chat frame as if they came from your character. + -- @function CharacterMessage + -- @tparam string message The dialog to be displayed. + --------------------------------------------------------------------- + + function SV:CharacterMessage(message) local outbound = (messagePattern):format(playerName) - _send_message(msg, outbound) + _send_message(message, outbound) end end ---[[ CORE FUNCTIONS ]]-- +--------------------------------------------------------------------- +-- Utilities +-- @section UTILITIES Utilities used and shared by the SVUI core. +--------------------------------------------------------------------- + +--------------------------------------------------------------------- +-- Dummy function used to override existing methods, effectively killing them. +-- @function fubar +-- @return nothing. +-- @usage +-- -- Kill a function +-- SomeObject.some_function = SV.fubar +--------------------------------------------------------------------- function SV:fubar() return end +--------------------------------------------------------------------- +-- Request specific 'Static Popup' windows. +-- @function StaticPopup_Show +-- @tparam string arg Name of the popup +-- @usage +-- -- Open the 'Reload UI' popup +-- SV:StaticPopup_Show('RL_CLIENT') +--------------------------------------------------------------------- + function SV:StaticPopup_Show(arg) if arg == "ADDON_ACTION_FORBIDDEN" then StaticPopup_Hide(arg) end end +--------------------------------------------------------------------- +-- Reset all SVUI created settings to defaults. +-- @function ResetAllUI +--------------------------------------------------------------------- + function SV:ResetAllUI(confirmed) if InCombatLockdown()then SV:AddonMessage(ERR_NOT_IN_COMBAT) @@ -606,6 +669,11 @@ function SV:ResetAllUI(confirmed) SV.Events:Trigger("FULL_UI_RESET"); end +--------------------------------------------------------------------- +-- Reset layout positions back to their default. +-- @function ResetUI +--------------------------------------------------------------------- + function SV:ResetUI(confirmed) if InCombatLockdown()then self:AddonMessage(ERR_NOT_IN_COMBAT) @@ -618,6 +686,11 @@ function SV:ResetUI(confirmed) self:ResetAnchors() end +--------------------------------------------------------------------- +-- Open the config menu ('/sv'). +-- @function ToggleConfig +--------------------------------------------------------------------- + function SV:ToggleConfig() if InCombatLockdown() then self:AddonMessage(ERR_NOT_IN_COMBAT) @@ -643,6 +716,11 @@ function SV:ToggleConfig() end end +--------------------------------------------------------------------- +-- Checks to see which (if any) version of the core that the client has installed. +-- @function VersionCheck +--------------------------------------------------------------------- + function SV:VersionCheck() local delayed; if(_G.SVUI_TRANSFER_WIZARD) then @@ -660,6 +738,11 @@ function SV:VersionCheck() end end +--------------------------------------------------------------------- +-- Reloads all current packages and modules. +-- @function RefreshEverything +--------------------------------------------------------------------- + function SV:RefreshEverything(bypass) self:UpdateSharedMedia(); self:UpdateAnchors(); @@ -669,7 +752,7 @@ function SV:RefreshEverything(bypass) end end ---[[ EVENT HANDLERS ]]-- +---- EVENT HANDLERS ---- function SV:PLAYER_ENTERING_WORLD() self.GUID = UnitGUID('player'); @@ -697,12 +780,12 @@ end function SV:PET_BATTLE_CLOSE() self:AuditVisibility() SVUILib:LiveUpdate() - -- self.Events:Trigger("FONT_GROUP_UPDATED", "chatdialog", "chattab"); + ---- self.Events:Trigger("FONT_GROUP_UPDATED", "chatdialog", "chattab"); ---- end function SV:PET_BATTLE_OPENING_START() self:AuditVisibility(true); - -- self.Events:Trigger("FONT_GROUP_UPDATED", "chatdialog", "chattab"); + ---- self.Events:Trigger("FONT_GROUP_UPDATED", "chatdialog", "chattab"); ---- end function SV:PLAYER_REGEN_DISABLED() @@ -740,7 +823,7 @@ function SV:TaintHandler(event, taint, sourceName, sourceFunc) self:AddonMessage(errorString) end ---[[ LOAD FUNCTIONS ]]-- +---- LOAD FUNCTIONS ---- function SV:ReLoad() self:RefreshAllMedia(); @@ -792,7 +875,7 @@ function SV:Initialize() wipe(self.ERRORLOG) end - --print(p1 .. ", " .. p2:GetName() .. ", " .. p3 .. ", " .. p4 .. ", " .. p5) + ---- print(p1 .. ", " .. p2:GetName() .. ", " .. p3 .. ", " .. p4 .. ", " .. p5) ---- collectgarbage("collect"); @@ -800,17 +883,16 @@ function SV:Initialize() self.Timers:ExecuteTimer(self.RollCredits, 10) end end ---[[ -########################################################## -THE CLEANING LADY -########################################################## -]]-- + +---- ################# ---- +---- THE CLEANING LADY ---- +---- ################# ---- local LemonPledge = 0; local Consuela = CreateFrame("Frame") Consuela:RegisterAllEvents() Consuela:SetScript("OnEvent", function(self, event) LemonPledge = LemonPledge + 1 - --print(event) + ---- print(event) ---- if(InCombatLockdown()) then return end; if(LemonPledge > 10000) then collectgarbage("collect"); diff --git a/SVUI_!Core/system/media.lua b/SVUI_!Core/system/media.lua index a36df61..239279c 100644 --- a/SVUI_!Core/system/media.lua +++ b/SVUI_!Core/system/media.lua @@ -1,11 +1,6 @@ ---[[ -########################################################## -S V U I By: Munglunch -########################################################## -LOCALIZED LUA FUNCTIONS -########################################################## -]]-- ---[[ GLOBALS ]]-- +--- Handlers for media functions +-- @submodule SVUI_Core + local _G = _G; local select = _G.select; local unpack = _G.unpack; @@ -17,17 +12,9 @@ local string = _G.string; local math = _G.math; local table = _G.table; local GetTime = _G.GetTime; ---[[ STRING METHODS ]]-- local format = string.format; ---[[ MATH METHODS ]]-- local floor, modf = math.floor, math.modf; ---[[ TABLE METHODS ]]-- local twipe, tsort = table.wipe, table.sort; ---[[ -########################################################## -LOCALIZED GLOBALS -########################################################## -]]-- local NAMEPLATE_FONT = _G.NAMEPLATE_FONT local CHAT_FONT_HEIGHTS = _G.CHAT_FONT_HEIGHTS local STANDARD_TEXT_FONT = _G.STANDARD_TEXT_FONT @@ -35,21 +22,13 @@ local UNIT_NAME_FONT = _G.UNIT_NAME_FONT local CUSTOM_CLASS_COLORS = _G.CUSTOM_CLASS_COLORS local RAID_CLASS_COLORS = _G.RAID_CLASS_COLORS local UIDROPDOWNMENU_DEFAULT_TEXT_HEIGHT = _G.UIDROPDOWNMENU_DEFAULT_TEXT_HEIGHT ---[[ -########################################################## -GET ADDON DATA -########################################################## -]]-- +---- GET ADDON DATA ---- local SV = select(2, ...) local SVUILib = Librarian("Registry") local L = SV.L local classToken = select(2,UnitClass("player")) SV.MaxBackdrops = {Pattern = 14, Art = 5, Unit = 17} ---[[ -########################################################## -DEFINE SOUND EFFECTS -########################################################## -]]-- +---- DEFINE SOUND EFFECTS ---- local SOUND = SV.Sounds; SOUND:Register("Buttons", [[sound\interface\uchatscrollbutton.ogg]]) @@ -78,11 +57,7 @@ SOUND:Register("Wired", [[sound\doodad\goblin_christmaslight_green_01.ogg]]) SOUND:Register("Wired", [[sound\doodad\goblin_christmaslight_green_02.ogg]]) SOUND:Register("Wired", [[sound\doodad\goblin_christmaslight_green_03.ogg]]) SOUND:Register("Phase", [[sound\doodad\be_scryingorb_explode.ogg]]) ---[[ -########################################################## -DEFINE SHARED MEDIA -########################################################## -]]-- +---- DEFINE SHARED MEDIA ---- local LSM = _G.LibStub("LibSharedMedia-3.0") LSM:Register("background", "SVUI Default BG", [[Interface\AddOns\SVUI_!Core\assets\backgrounds\DEFAULT]]) @@ -134,11 +109,7 @@ LSM:Register("font", "SVUI Flash Font", [[Interface\AddOns\SVUI_!Core\assets\fon LSM:Register("font", "SVUI Alert Font", [[Interface\AddOns\SVUI_!Core\assets\fonts\Alert.ttf]]) LSM:Register("font", "SVUI Narrator Font", [[Interface\AddOns\SVUI_!Core\assets\fonts\Narrative.ttf]]) LSM:Register("font", "Open-Dyslexic", [[Interface\AddOns\SVUI_!Core\assets\fonts\Dyslexic.ttf]]) ---[[ -########################################################## -CREATE AND POPULATE MEDIA DATA -########################################################## -]]-- +---- CREATE AND POPULATE MEDIA DATA ---- do local cColor = RAID_CLASS_COLORS[classToken] local r1,g1,b1 = cColor.r,cColor.g,cColor.b @@ -543,11 +514,7 @@ do } }; end ---[[ -########################################################## -SOME CORE VARS -########################################################## -]]-- +---- SOME CORE VARS ---- SV.DialogFontDefault = "SVUI Dialog Font"; if(GetLocale() ~= "enUS") then SV.DialogFontDefault = "SVUI Default Font"; @@ -555,31 +522,49 @@ end SV.SplashImage = [[Interface\AddOns\SVUI_!Core\assets\textures\SPLASH]]; SV.BaseTexture = [[Interface\AddOns\SVUI_!Core\assets\backgrounds\DEFAULT]]; SV.NoTexture = [[Interface\AddOns\SVUI_!Core\assets\textures\EMPTY]]; ---[[ -########################################################## -CORE FUNCTIONS -########################################################## -]]-- -function SV:ColorGradient(perc, ...) - if perc >= 1 then + +--------------------------------------------------------------------- +-- Returns a color value based on percentages. +-- @function ColorGradient +-- @tparam number percentage The needed gradient percent. +-- @param ... (vararg) remaining arguments are up to 3 sets of numeric color values (r,g,b). +-- @return red value, green value, blue value +-- @usage SV:ColorGradient(50,1,0,0,1,1,0,0,1,0) +--------------------------------------------------------------------- + +function SV:ColorGradient(percentage, ...) + if percentage >= 1 then return select(select('#', ...) - 2, ...) - elseif perc <= 0 then + elseif percentage <= 0 then return ... end local num = select('#', ...) / 3 - local segment, relperc = modf(perc*(num-1)) + local segment, relative = modf(percentage*(num-1)) local r1, g1, b1, r2, g2, b2 = select((segment*3)+1, ...) - return r1 + (r2-r1)*relperc, g1 + (g2-g1)*relperc, b1 + (b2-b1)*relperc + local rOut = r1 + (r2-r1)*relative; + local gOut = g1 + (g2-g1)*relative; + local bOut = b1 + (b2-b1)*relative; + return rOut, gOut, bOut end -function SV:HexColor(arg1,arg2,arg3) +--------------------------------------------------------------------- +-- Returns a hexadecimal color value. +-- @function HexColor +-- @tparam number red Color, red value. +-- @tparam number green Color, green value. +-- @tparam number blue Color, blue value. +-- @return Hexadecimal string color +-- @usage SV:HexColor(0.1, 0.2, 0.3) +--------------------------------------------------------------------- + +function SV:HexColor(red, green, blue) local r,g,b; - if arg1 and type(arg1) == "string" then + if red and type(red) == "string" then local t if(self.media) then - t = self.media.color[arg1] + t = self.media.color[red] if((not t) and (self.media.extended and self.media.extended.unitframes)) then - t = self.media.extended.unitframes[arg1] + t = self.media.extended.unitframes[red] end end if t then @@ -588,9 +573,9 @@ function SV:HexColor(arg1,arg2,arg3) r,g,b = 0,0,0 end else - r = type(arg1) == "number" and arg1 or 0; - g = type(arg2) == "number" and arg2 or 0; - b = type(arg3) == "number" and arg3 or 0; + r = type(red) == "number" and red or 0; + g = type(green) == "number" and green or 0; + b = type(blue) == "number" and blue or 0; end r = (r < 0 or r > 1) and 0 or (r * 255) g = (g < 0 or g > 1) and 0 or (g * 255) @@ -598,11 +583,9 @@ function SV:HexColor(arg1,arg2,arg3) local hexString = ("%02x%02x%02x"):format(r,g,b) return hexString end ---[[ -########################################################## -ALTERING GLOBAL FONTS -########################################################## -]]-- + +---- ALTERING GLOBAL FONTS ---- + local function UpdateChatFontSizes() _G.CHAT_FONT_HEIGHTS[1] = 8 _G.CHAT_FONT_HEIGHTS[2] = 9 @@ -629,21 +612,34 @@ local function ChangeGlobalFonts() UpdateChatFontSizes() UIDROPDOWNMENU_DEFAULT_TEXT_HEIGHT = fontsize end ---[[ -########################################################## -FONT TEMPLATING METHODS -########################################################## -]]-- + +---- FONT TEMPLATING METHODS ---- + local ManagedFonts = {}; -function SV:FontManager(obj, template, arg, sizeMod, styleOverride, colorR, colorG, colorB) +--------------------------------------------------------------------- +-- Adds a font object to the custom SVUI font manager. +-- @function FontManager +-- @param obj Font object. +-- @tparam string template Internal name of the media-font to be assigned. +-- @param abstract A multi-use flag. +-- @param sizeMod Font size override. +-- @param styleOverride Outline override. +-- @tparam number red Color, red value. +-- @tparam number green Color, green value. +-- @tparam number blue Color, blue value. +-- @usage SV:FontManager(FontObject, 'default', false, false, 'OUTLINE', 1, 1, 1) +--------------------------------------------------------------------- + +function SV:FontManager(obj, template, abstract, sizeMod, styleOverride, red, green, blue) + -- @todo document this better if not obj then return end template = template or "default"; local info = SV.media.shared.font[template] or SV.media.shared.font.default; if(not info) then return end local isSystemFont = false; - if(arg and (arg == 'SYSTEM')) then + if(abstract and (abstract == 'SYSTEM')) then isSystemFont = true; end @@ -659,7 +655,7 @@ function SV:FontManager(obj, template, arg, sizeMod, styleOverride, colorR, colo obj.___fontSizeMod = sizeMod or 0; obj:SetFont(file, (size + obj.___fontSizeMod), outline) - if(arg == 'SHADOW') then + if(abstract == 'SHADOW') then obj:SetShadowColor(0, 0, 0, 0.75) obj:SetShadowOffset(2, -2) elseif(not isSystemFont) then @@ -675,12 +671,12 @@ function SV:FontManager(obj, template, arg, sizeMod, styleOverride, colorR, colo else obj:SetShadowOffset(0, 0) end - obj:SetJustifyH(arg or "CENTER") + obj:SetJustifyH(abstract or "CENTER") obj:SetJustifyV("MIDDLE") end - if(colorR and colorG and colorB) then - obj:SetTextColor(colorR, colorG, colorB); + if(red and green and blue) then + obj:SetTextColor(red, green, blue); end if(not ManagedFonts[template]) then @@ -711,7 +707,7 @@ local function ChangeSystemFonts() _alterFont("GameFontBlack", "default", 0, 'NONE', 0, 0, 0) _alterFont("GameFontBlackSmall", "default", -1, 'NONE', 0, 0, 0) _alterFont("GameFontNormalMed2", "default", 2) - --_alterFont("GameFontNormalMed1", "default", 0) + ---- _alterFont("GameFontNormalMed1", "default", 0) ---- _alterFont("GameFontNormalLarge", "default") _alterFont("GameFontNormalLargeOutline", "default") _alterFont("GameFontHighlightSmall", "default") @@ -823,6 +819,16 @@ end SV.Events:On("ALL_FONTS_UPDATED", UpdateAllFontTemplates, true); SV.Events:On("FONT_GROUP_UPDATED", UpdateFontGroup, true); +--------------------------------------------------------------------- +-- Create an add-in set of specific font configuration options. +-- @function GenerateFontOptionGroup +-- @tparam string groupName Options group to insert into. +-- @tparam number groupCount Option order for this option. +-- @tparam string groupOverview Option group name for this option. +-- @tparam table groupList Array of relevant font data. +-- @usage SV:GenerateFontOptionGroup(groupName, groupCount, groupOverview, groupList) +--------------------------------------------------------------------- + function SV:GenerateFontOptionGroup(groupName, groupCount, groupOverview, groupList) self.Options.args.Fonts.args.fontGroup.args[groupName] = { order = groupCount, @@ -914,11 +920,9 @@ function SV:GenerateFontOptionGroup(groupName, groupCount, groupOverview, groupL } end end ---[[ -########################################################## -MEDIA CORE -########################################################## -]]-- + +---- MEDIA CORE ---- + local function tablesplice(mergeTable, targetTable) if type(targetTable) ~= "table" then targetTable = {} end if type(mergeTable) == 'table' then @@ -1114,10 +1118,10 @@ function SV:UpdateSharedMedia() self.media.gradient.bizzaro = {"VERTICAL", ir2, ig2, ib2, ir1, ig1, ib1} local special = self.media.color.special - -- self.media.gradient.special = {"VERTICAL", special[1], special[2], special[3], r1, g1, b1} - -- self.media.color.special = {r1*.5, g1*.5, b1*.5, 1} + ---- self.media.gradient.special = {"VERTICAL", special[1], special[2], special[3], r1, g1, b1} ---- + ---- self.media.color.special = {r1*.5, g1*.5, b1*.5, 1} ---- self.media.gradient.special = {"VERTICAL", special[1]*.25, special[2]*.25, special[3]*.25, special[1], special[2], special[3]} - -- self.media.gradient.special = {"VERTICAL",special[1], special[2], special[3], default[1], default[2], default[3]} + ---- self.media.gradient.special = {"VERTICAL",special[1], special[2], special[3], default[1], default[2], default[3]} ---- self.Events:Trigger("SHARED_MEDIA_UPDATED"); if(not InCombatLockdown()) then