mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2025-12-27 19:45:22 +09:00
Cleaner docs
This commit is contained in:
@@ -348,7 +348,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -349,7 +349,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -376,7 +376,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -585,7 +585,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -349,7 +349,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -404,7 +404,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -460,7 +460,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -404,7 +404,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -320,7 +320,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -404,7 +404,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -376,7 +376,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -388,7 +388,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -500,7 +500,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -361,7 +361,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -388,7 +388,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -365,7 +365,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -360,7 +360,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -404,7 +404,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -458,7 +458,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -416,7 +416,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -611,7 +611,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -389,7 +389,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -360,7 +360,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -388,7 +388,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -321,7 +321,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -585,7 +585,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -557,7 +557,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -389,7 +389,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -443,7 +443,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -484,7 +484,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -569,7 +569,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -506,7 +506,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -237,7 +237,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -485,7 +485,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -294,7 +294,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -320,7 +320,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -442,7 +442,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -354,7 +354,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -338,7 +338,7 @@ see ./expcore/commands.lua for more details</p>
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -354,7 +354,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -416,7 +416,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -237,7 +237,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -240,7 +240,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -295,7 +295,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -812,7 +812,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -384,7 +384,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -414,7 +414,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -324,7 +324,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -414,7 +414,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -834,7 +834,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -292,7 +292,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -354,7 +354,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -388,7 +388,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -744,7 +744,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -384,7 +384,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -355,7 +355,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -684,7 +684,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1208,7 +1208,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1329,7 +1329,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1110,7 +1110,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -984,7 +984,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1039,7 +1039,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1465,7 +1465,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1413,7 +1413,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1972,7 +1972,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -2480,7 +2480,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -233,6 +233,41 @@
|
||||
<!-- module info end -->
|
||||
|
||||
<!-- module usage start -->
|
||||
<h3>Usage</h3>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Making the base button concept
|
||||
</span><span class="keyword">local</span> button =
|
||||
Gui.new_concept(<span class="string">'Button'</span>)
|
||||
:new_event(<span class="string">'on_click'</span>,defines.events.on_gui_click)
|
||||
:new_property(<span class="string">'tooltip'</span>)
|
||||
:new_property(<span class="string">'caption'</span>,<span class="keyword">nil</span>,<span class="keyword">function</span>(properties,value)
|
||||
properties.caption = value
|
||||
properties.sprite = <span class="keyword">nil</span>
|
||||
properties.<span class="global">type</span> = <span class="string">'button'</span>
|
||||
<span class="keyword">end</span>)
|
||||
:new_property(<span class="string">'sprite'</span>,<span class="keyword">nil</span>,<span class="keyword">function</span>(properties,value)
|
||||
properties.image = value
|
||||
properties.caption = <span class="keyword">nil</span>
|
||||
properties.<span class="global">type</span> = <span class="string">'sprite-button'</span>
|
||||
<span class="keyword">end</span>)</code></pre>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Makeing a alternative button based on the first
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
button:clone(<span class="string">'CustomButton'</span>)
|
||||
:new_event(<span class="string">'on_admin_clicked'</span>,defines.events.on_gui_click,<span class="keyword">function</span>(event)
|
||||
<span class="keyword">return</span> event.player.admin <span class="comment">-- only raise custom event when an admin clicks the button
|
||||
</span><span class="keyword">end</span>)
|
||||
:set_caption(<span class="string">'Custom Button'</span>)
|
||||
:set_tooltip(<span class="string">'Only admins can press this button'</span>)
|
||||
:on_click(<span class="keyword">function</span>(event)
|
||||
<span class="keyword">if</span> <span class="keyword">not</span> event.player.admin <span class="keyword">then</span>
|
||||
event.player.<span class="global">print</span>(<span class="string">'You must be admin to use this button'</span>)
|
||||
<span class="keyword">end</span>
|
||||
<span class="keyword">end</span>)
|
||||
:on_admin_clicked(<span class="keyword">function</span>(event)
|
||||
<span class="comment">-- Yes i know this can just be an if else but its an example
|
||||
</span> game.<span class="global">print</span>(event.player.name..<span class="string">' pressed my admin button'</span>)
|
||||
<span class="keyword">end</span>)</code></pre>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Drawing a concept
|
||||
</span>custom_button:draw(game.player.gui.left)</code></pre>
|
||||
<!-- module usage end -->
|
||||
|
||||
<!-- module content header end -->
|
||||
@@ -404,8 +439,8 @@
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Clones the base Button concept to make a alternative button
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'Button'</span>):clone(<span class="string">'CustomButton'</span>)</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
@@ -499,8 +534,8 @@ Gui.get_concept(<span class="string">'Button'</span>):clone(<span class="string"
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Adds an on_admin_clicked event to fire when ever an admin clicks the button
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'Button'</span>):clone(<span class="string">'CustomButton'</span>)
|
||||
:new_event(<span class="string">'on_admin_clicked'</span>,defines.events.on_gui_click,<span class="keyword">function</span>(event)
|
||||
<span class="keyword">return</span> event.player.admin <span class="comment">-- only raise custom event when an admin clicks the button
|
||||
@@ -563,9 +598,9 @@ Gui.get_concept(<span class="string">'Button'</span>):clone(<span class="string"
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>):clone(<span class="string">'MyCustomButton'</span>)
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- When an admin clicks the button a message is printed
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
:on_admin_clicked(<span class="keyword">function</span>(event)
|
||||
game.<span class="global">print</span>(event.player.name..<span class="string">' pressed my admin button'</span>)
|
||||
<span class="keyword">end</span>)</code></pre>
|
||||
@@ -654,8 +689,8 @@ Gui.get_concept(<span class="string">'CustomButton'</span>):clone(<span class="s
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Raising the custom event on_admin_clicked
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<span class="comment">-- Note that this is an example and would not work due it expecting a valid element for event.element
|
||||
@@ -754,8 +789,8 @@ Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Adding caption, sprite, and tooltip to the base button concept
|
||||
</span><span class="keyword">local</span> button =
|
||||
Gui.get_concept(<span class="string">'Button'</span>)
|
||||
:new_property(<span class="string">'tooltip'</span>)
|
||||
:new_property(<span class="string">'caption'</span>,<span class="keyword">nil</span>,<span class="keyword">function</span>(properties,value)
|
||||
@@ -826,12 +861,11 @@ Gui.get_concept(<span class="string">'Button'</span>)
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Setting the caption on the base button concept after a cloning
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'Button'</span>)
|
||||
:set_caption(<span class="string">'Default Button'</span>)</code></pre>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="comment">-- In our examples CustomButton is cloned from Button, this means the caption property already exists
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- In our examples CustomButton is cloned from Button, this means the caption property already exists
|
||||
</span><span class="comment">-- note that what ever values that properties have at the time of cloning are also copied
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
@@ -894,8 +928,8 @@ Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Adding the draw define for the base button concept, we then return the element
|
||||
</span><span class="keyword">local</span> button =
|
||||
Gui.get_concept(<span class="string">'Button'</span>)
|
||||
:define_draw(<span class="keyword">function</span>(properties,parent,element)
|
||||
<span class="comment">-- Note that element might be nil if this is the first draw function
|
||||
@@ -981,8 +1015,8 @@ Gui.get_concept(<span class="string">'Button'</span>)
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Drawing the custom button concept
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<span class="comment">-- Note that the draw function from button was cloned, so unless we want to alter the base button we dont need a new draw define
|
||||
@@ -1049,8 +1083,8 @@ Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="comment">-- Note even thou this is a copy of Button; if Button had an instance store it would not be cloned over
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Allowing storing instances of the custom button; stored by the players index
|
||||
</span><span class="comment">-- Note even thou this is a copy of Button; if Button had an instance store it would not be cloned over
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
:define_instance_store(<span class="keyword">function</span>(element)
|
||||
@@ -1115,8 +1149,8 @@ Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Getting all the instances of the player with index 1
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
custom_button.get_instances(<span class="number">1</span>) -- player index <span class="number">1</span></code></pre>
|
||||
@@ -1188,8 +1222,8 @@ custom_button.get_instances(<span class="number">1</span>) -- player index <span
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Adding an element as a instance for this concept, mostly for internal use
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
custom_button.add_instance(element) -- normally <span class="keyword">not</span> needed due to use <span class="keyword">in</span> concept:draw</code></pre>
|
||||
@@ -1261,12 +1295,11 @@ custom_button.add_instance(element) -- normally <span class="keyword">not</span>
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Changing the font color of all instances for player 1
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<span class="comment">-- Change all the instances to have red text for player 1
|
||||
</span>custom_button.update_instances(<span class="number">1</span>,<span class="keyword">function</span>(element)
|
||||
custom_button.update_instances(<span class="number">1</span>,<span class="keyword">function</span>(element)
|
||||
element.style.font_color = {r=<span class="number">1</span>,g=<span class="number">0</span>,b=<span class="number">0</span>}
|
||||
<span class="keyword">end</span>)</code></pre>
|
||||
<!-- usage end -->
|
||||
@@ -1331,8 +1364,8 @@ Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="comment">-- Note even thou this is a copy of Button; if Button had an data store it would not be cloned over
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Adding a way to store data for this concept; each player has their own store
|
||||
</span><span class="comment">-- Note even thou this is a copy of Button; if Button had an data store it would not be cloned over
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
:define_data_store(<span class="keyword">function</span>(element)
|
||||
@@ -1397,8 +1430,8 @@ Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Getting the stored data for player 1
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
custom_button.get_data(<span class="number">1</span>) -- player index <span class="number">1</span></code></pre>
|
||||
@@ -1470,8 +1503,8 @@ custom_button.get_data(<span class="number">1</span>) -- player index <span clas
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Setting the data for player 1 to a table with two keys
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<span class="comment">-- A table is used to show correct way to use a table with self.update_data
|
||||
@@ -1532,8 +1565,8 @@ Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Clearing the data for player 1
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
custom_button.clear_data(<span class="number">1</span>) -- player index <span class="number">1</span></code></pre>
|
||||
@@ -1605,16 +1638,15 @@ custom_button.clear_data(<span class="number">1</span>) -- player index <span cl
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Updating the clicks key in the concept data for player 1
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
custom_button.update_data(<span class="number">1</span>,<span class="keyword">function</span>(tbl)
|
||||
tbl.clicks = tbl.clicks + <span class="number">1</span> <span class="comment">-- here we are incrementing the clicks by 1
|
||||
</span><span class="keyword">end</span>) <span class="comment">-- player index 1
|
||||
</span></code></pre>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="comment">-- Alterative method more useful when not using a table
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Updating a value when a table is not used, alterative to get set
|
||||
</span><span class="comment">-- so for this example assume that we did custom_button.set_data(1,0)
|
||||
</span>custom_button.update_data(<span class="number">1</span>,<span class="keyword">function</span>(value)
|
||||
<span class="keyword">return</span> value + <span class="number">1</span> <span class="comment">-- here we are incrementing the value by 1, we may only be tracking clicks
|
||||
@@ -1710,8 +1742,8 @@ custom_button.update_data(<span class="number">1</span>,<span class="keyword">fu
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Adding a way to sync captions bettween all instances, more useful for things that arnt buttons
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
:define_combined_store(
|
||||
<span class="keyword">function</span>(element)
|
||||
@@ -1774,8 +1806,8 @@ Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Setting the caption of this element to be the same as the stored value
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<span class="comment">-- Used internally when first draw and automatically when the store updates
|
||||
@@ -1831,8 +1863,8 @@ Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="keyword">local</span> custom_button =
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Setting the stored value to be the same as the caption for this element
|
||||
</span><span class="keyword">local</span> custom_button =
|
||||
Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
|
||||
<span class="comment">-- You may want to use this with gui events
|
||||
@@ -1855,7 +1887,7 @@ Gui.get_concept(<span class="string">'CustomButton'</span>)
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1432,7 +1432,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -3152,7 +3152,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1128,7 +1128,7 @@ Store.register(team_scores,<span class="keyword">function</span>(value,key)
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -544,7 +544,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -626,7 +626,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -629,7 +629,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -449,7 +449,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -632,7 +632,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -837,7 +837,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -510,7 +510,7 @@ see ./expcore/commands.lua for more details</span></td>
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -351,7 +351,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -419,7 +419,7 @@ fraction will decide a chance to spawn. 1 alien for 2 spawner's will have 50% on
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1164,7 +1164,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -654,7 +654,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -323,7 +323,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1292,7 +1292,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -434,7 +434,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -338,7 +338,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -441,7 +441,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -752,7 +752,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1382,7 +1382,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -651,7 +651,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -442,7 +442,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -789,7 +789,7 @@ Public License instead of this License. But first, please read
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -332,7 +332,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-08-25 00:50:15 UTC</i>
|
||||
<i>Last updated 2019-08-25 01:11:55 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1,6 +1,43 @@
|
||||
--[[-- Core Module - Gui
|
||||
@core Gui
|
||||
@alias Gui
|
||||
|
||||
@usage-- Making the base button concept
|
||||
local button =
|
||||
Gui.new_concept('Button')
|
||||
:new_event('on_click',defines.events.on_gui_click)
|
||||
:new_property('tooltip')
|
||||
:new_property('caption',nil,function(properties,value)
|
||||
properties.caption = value
|
||||
properties.sprite = nil
|
||||
properties.type = 'button'
|
||||
end)
|
||||
:new_property('sprite',nil,function(properties,value)
|
||||
properties.image = value
|
||||
properties.caption = nil
|
||||
properties.type = 'sprite-button'
|
||||
end)
|
||||
|
||||
@usage-- Makeing a alternative button based on the first
|
||||
local custom_button =
|
||||
button:clone('CustomButton')
|
||||
:new_event('on_admin_clicked',defines.events.on_gui_click,function(event)
|
||||
return event.player.admin -- only raise custom event when an admin clicks the button
|
||||
end)
|
||||
:set_caption('Custom Button')
|
||||
:set_tooltip('Only admins can press this button')
|
||||
:on_click(function(event)
|
||||
if not event.player.admin then
|
||||
event.player.print('You must be admin to use this button')
|
||||
end
|
||||
end)
|
||||
:on_admin_clicked(function(event)
|
||||
-- Yes i know this can just be an if else but its an example
|
||||
game.print(event.player.name..' pressed my admin button')
|
||||
end)
|
||||
|
||||
@usage-- Drawing a concept
|
||||
custom_button:draw(game.player.gui.left)
|
||||
]]
|
||||
|
||||
local Gui = require 'expcore.gui.core'
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
@module Gui
|
||||
@alias Prototype
|
||||
|
||||
@usage
|
||||
@usage DX note - chaning this doc string has no effect on the docs
|
||||
|
||||
local button =
|
||||
Gui.new_concept('Button')
|
||||
:new_event('on_click',defines.events.on_gui_click)
|
||||
@@ -74,7 +75,7 @@ end
|
||||
--[[-- Used to copy all the settings from one concept to another and removing links to the orginal
|
||||
@tparam string concept_name the name of the new concept; must be unique
|
||||
@treturn GuiConcept the base for building a custom gui
|
||||
@usage
|
||||
@usage-- Clones the base Button concept to make a alternative button
|
||||
local custom_button =
|
||||
Gui.get_concept('Button'):clone('CustomButton')
|
||||
]]
|
||||
@@ -124,7 +125,7 @@ end
|
||||
@tparam[opt] defines.events factorio_event when given will fire the custom event when the factorio event is raised
|
||||
@tparam[opt] function event_condition used to filter when a factorio event triggers the custom event; if the event contains a reference to an element then names are automatically filtered
|
||||
@treturn GuiConcept to allow chaing of functions
|
||||
@usage
|
||||
@usage-- Adds an on_admin_clicked event to fire when ever an admin clicks the button
|
||||
local custom_button =
|
||||
Gui.get_concept('Button'):clone('CustomButton')
|
||||
:new_event('on_admin_clicked',defines.events.on_gui_click,function(event)
|
||||
@@ -141,9 +142,9 @@ function Prototype:new_event(event_name,factorio_event,event_condition)
|
||||
@function Prototype:on_custom_event
|
||||
@tparam function handler the function which will recive the event
|
||||
@treturn GuiConcept to allow chaing of functions
|
||||
@usage
|
||||
@usage-- When an admin clicks the button a message is printed
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton'):clone('MyCustomButton')
|
||||
Gui.get_concept('CustomButton')
|
||||
:on_admin_clicked(function(event)
|
||||
game.print(event.player.name..' pressed my admin button')
|
||||
end)
|
||||
@@ -179,7 +180,7 @@ end
|
||||
@tparam string event_name the name of the event that you want to raise
|
||||
@tparam[opt={}] table event table containg data you want to send with the event, some keys already included
|
||||
@tparam[opt=false] boolean from_factorio internal use, if the raise came from the factorio event handler
|
||||
@usage
|
||||
@usage-- Raising the custom event on_admin_clicked
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
|
||||
@@ -225,7 +226,7 @@ end
|
||||
@tparam any default the default value for this property, although not strictly required is is strongly recomented
|
||||
@tparam[opt] function setter_callback this function is called when set is called, if not provided then key in concept.properties is updated to new value
|
||||
@treturn GuiConcept to allow chaing of functions
|
||||
@usage
|
||||
@usage-- Adding caption, sprite, and tooltip to the base button concept
|
||||
local button =
|
||||
Gui.get_concept('Button')
|
||||
:new_property('tooltip')
|
||||
@@ -253,13 +254,12 @@ function Prototype:new_property(property_name,default,setter_callback)
|
||||
@function Prototype:set_custom_property
|
||||
@tparam any value the value that you want to set for this property
|
||||
@treturn GuiConcept to allow chaing of functions
|
||||
@usage
|
||||
@usage-- Setting the caption on the base button concept after a cloning
|
||||
local custom_button =
|
||||
Gui.get_concept('Button')
|
||||
:set_caption('Default Button')
|
||||
|
||||
@usage
|
||||
-- In our examples CustomButton is cloned from Button, this means the caption property already exists
|
||||
@usage-- In our examples CustomButton is cloned from Button, this means the caption property already exists
|
||||
-- note that what ever values that properties have at the time of cloning are also copied
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
@@ -287,7 +287,7 @@ end
|
||||
--[[-- Used to define how the concept is turned into an ingame element or "instance" as we may refer to them
|
||||
@tparam function draw_callback the function that will be called to draw/update the instance; this function must return the instance or the new acting instance
|
||||
@treturn GuiConcept to allow chaing of functions
|
||||
@usage
|
||||
@usage-- Adding the draw define for the base button concept, we then return the element
|
||||
local button =
|
||||
Gui.get_concept('Button')
|
||||
:define_draw(function(properties,parent,element)
|
||||
@@ -332,7 +332,7 @@ end
|
||||
--[[-- Calls all the draw functions in order to create this concept in game; will also store and sync the instance if stores are used
|
||||
@tparam LuaGuiElement parent_element the element that the concept will use as a base
|
||||
@treturn LuaGuiElement the element that was created and then passed though and returned by the draw functions
|
||||
@usage
|
||||
@usage-- Drawing the custom button concept
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
|
||||
@@ -372,7 +372,7 @@ end
|
||||
--[[-- Adds an instance store to the concept; when a new instance is made it is stored so you can access it later
|
||||
@tparam[opt] function category_callback when given will act as a way to turn an element into a string to act as a key; keys returned can over lap
|
||||
@treturn GuiConcept to allow chaing of functions
|
||||
@usage
|
||||
@usage-- Allowing storing instances of the custom button; stored by the players index
|
||||
-- Note even thou this is a copy of Button; if Button had an instance store it would not be cloned over
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
@@ -392,7 +392,7 @@ function Prototype:define_instance_store(category_callback)
|
||||
@function Prototype.get_instances
|
||||
@tparam[opt] ?string|LuaGuiElement category the category to get, can only be nil if categories are not used
|
||||
@treturn table a table which contains all the instances
|
||||
@usage
|
||||
@usage-- Getting all the instances of the player with index 1
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
|
||||
@@ -406,7 +406,7 @@ custom_button.get_instances(1) -- player index 1
|
||||
@function Prototype.add_instance
|
||||
@tparam LuaGuiElement element the element that will be added as an instance
|
||||
@tparam[opt] string category the category to add this element under, if nil the category callback is used to assign one
|
||||
@usage
|
||||
@usage-- Adding an element as a instance for this concept, mostly for internal use
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
|
||||
@@ -428,11 +428,10 @@ custom_button.add_instance(element) -- normally not needed due to use in concept
|
||||
@function Prototype.update_instances
|
||||
@tparam[opt] ?string|LuaGuiElement category the category to get, can only be nil if categories are not used
|
||||
@tparam function update_callback the function which is called on each instance, recives other args passed to update_instances
|
||||
@usage
|
||||
@usage-- Changing the font color of all instances for player 1
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
|
||||
-- Change all the instances to have red text for player 1
|
||||
custom_button.update_instances(1,function(element)
|
||||
element.style.font_color = {r=1,g=0,b=0}
|
||||
end)
|
||||
@@ -465,7 +464,7 @@ end
|
||||
--[[-- Adds a data store to this concept which allows you to store synced/percistent data between instances
|
||||
@tparam[opt] function category_callback when given will act as a way to turn an element into a string to act as a key; keys returned can over lap
|
||||
@treturn GuiConcept to allow chaing of functions
|
||||
@usage
|
||||
@usage-- Adding a way to store data for this concept; each player has their own store
|
||||
-- Note even thou this is a copy of Button; if Button had an data store it would not be cloned over
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
@@ -491,7 +490,7 @@ function Prototype:define_data_store(category_callback)
|
||||
@function Prototype.get_data
|
||||
@tparam[opt] ?string|LuaGuiElement category the category to get, can only be nil if categories are not used
|
||||
@treturn any the data that you had stored in this location
|
||||
@usage
|
||||
@usage-- Getting the stored data for player 1
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
|
||||
@@ -505,7 +504,7 @@ custom_button.get_data(1) -- player index 1
|
||||
@function Prototype.set_data
|
||||
@tparam[opt] ?string|LuaGuiElement category the category to set, can only be nil if categories are not used
|
||||
@tparam any value the data that you want to stored in this location
|
||||
@usage
|
||||
@usage-- Setting the data for player 1 to a table with two keys
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
|
||||
@@ -523,7 +522,7 @@ custom_button.set_data(1,{
|
||||
--[[-- Clears the data that is stored for this category
|
||||
@function Prototype.clear_data
|
||||
@tparam[opt] ?string|LuaGuiElement category the category to clear, can only be nil if categories are not used
|
||||
@usage
|
||||
@usage-- Clearing the data for player 1
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
|
||||
@@ -537,7 +536,7 @@ custom_button.clear_data(1) -- player index 1
|
||||
@function Prototype.update_data
|
||||
@tparam[opt] ?string|LuaGuiElement category the category to clear, can only be nil if categories are not used
|
||||
@tparam function update_callback the function which is called to update the data
|
||||
@usage
|
||||
@usage-- Updating the clicks key in the concept data for player 1
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
|
||||
@@ -545,8 +544,7 @@ custom_button.update_data(1,function(tbl)
|
||||
tbl.clicks = tbl.clicks + 1 -- here we are incrementing the clicks by 1
|
||||
end) -- player index 1
|
||||
|
||||
@usage
|
||||
-- Alterative method more useful when not using a table
|
||||
@usage-- Updating a value when a table is not used, alterative to get set
|
||||
-- so for this example assume that we did custom_button.set_data(1,0)
|
||||
custom_button.update_data(1,function(value)
|
||||
return value + 1 -- here we are incrementing the value by 1, we may only be tracking clicks
|
||||
@@ -564,7 +562,7 @@ end
|
||||
@tparam function get_callback the function which is called when you set the store from an instance
|
||||
@tparam function set_callback the function which is called when you update an instance using the value in the store
|
||||
@treturn GuiConcept to allow chaing of functions
|
||||
@usage
|
||||
@usage-- Adding a way to sync captions bettween all instances, more useful for things that arnt buttons
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
:define_combined_store(
|
||||
@@ -596,7 +594,7 @@ function Prototype:define_combined_store(category_callback,get_callback,set_call
|
||||
--[[-- Will set the state of an instance based on the value in the store
|
||||
@function Prototype.set_instance_from_store
|
||||
@tparam LuaGuiElement the element that you want to have update
|
||||
@usage
|
||||
@usage-- Setting the caption of this element to be the same as the stored value
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
|
||||
@@ -610,7 +608,7 @@ custom_button.set_instance_from_store(element)
|
||||
--[[-- Will set the value in the store and update the other instances based on the instance given
|
||||
@function Prototype.set_store_from_instance
|
||||
@tparam LuaGuiElement the element that you want to use to update the store
|
||||
@usage
|
||||
@usage-- Setting the stored value to be the same as the caption for this element
|
||||
local custom_button =
|
||||
Gui.get_concept('CustomButton')
|
||||
|
||||
|
||||
Reference in New Issue
Block a user