option_instance.html 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>xmake</title>
  6. <link rel="icon" href="/assets/img/favicon.ico">
  7. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
  8. <meta name="description" content="Description">
  9. <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
  10. <link href="/assets/npm/github-markdown/github-markdown.min.css" rel="stylesheet">
  11. <style>
  12. .markdown-body {
  13. box-sizing: border-box;
  14. min-width: 200px;
  15. max-width: 980px;
  16. margin: 0 auto;
  17. padding: 45px;
  18. }
  19. @media (max-width: 767px) {
  20. .markdown-body {
  21. padding: 15px;
  22. }
  23. }
  24. </style>
  25. </head>
  26. <body>
  27. <article class="markdown-body">
  28. <h4>This is a mirror page, please see the original page: </h4><a href="https://xmake.io/#/manual/option_instance">https://xmake.io/#/manual/option_instance</a>
  29. <div id="wwads-panel" class="wwads-cn wwads-vertical wwads-sticky" data-id="239" style="max-width:180px;bottom:20px;right:20px;width:200px;height:260px;background:#fff;position:fixed"></div>
  30. </br>
  31. <script type="text/javascript" charset="UTF-8" src="https://cdn.wwads.cn/js/makemoney.js" async></script>
  32. <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?serve=CE7I52QU&placement=xmakeio" id="_carbonads_js"></script>
  33. <style>
  34. #carbonads {
  35. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu,
  36. Cantarell, "Helvetica Neue", Helvetica, Arial, sans-serif;
  37. }
  38. #carbonads {
  39. display: flex;
  40. max-width: 330px;
  41. background-color: hsl(0, 0%, 98%);
  42. box-shadow: 0 1px 4px 1px hsla(0, 0%, 0%, .1);
  43. }
  44. #carbonads a {
  45. color: inherit;
  46. text-decoration: none;
  47. }
  48. #carbonads a:hover {
  49. color: inherit;
  50. }
  51. #carbonads span {
  52. position: relative;
  53. display: block;
  54. overflow: hidden;
  55. }
  56. #carbonads .carbon-wrap {
  57. display: flex;
  58. }
  59. .carbon-img {
  60. display: block;
  61. margin: 0;
  62. line-height: 1;
  63. }
  64. .carbon-img img {
  65. display: block;
  66. }
  67. .carbon-text {
  68. font-size: 13px;
  69. padding: 10px;
  70. line-height: 1.5;
  71. text-align: left;
  72. }
  73. .carbon-poweredby {
  74. display: block;
  75. padding: 8px 10px;
  76. background: repeating-linear-gradient(-45deg, transparent, transparent 5px, hsla(0, 0%, 0%, .025) 5px, hsla(0, 0%, 0%, .025) 10px) hsla(203, 11%, 95%, .4);
  77. text-align: center;
  78. text-transform: uppercase;
  79. letter-spacing: .5px;
  80. font-weight: 600;
  81. font-size: 9px;
  82. line-height: 1;
  83. }
  84. </style>
  85. <p>This page describes the interface for <code>option</code> of functions like <code>on_load()</code>, <code>on_check()</code> or <code>after_check()</code> of the <a href="manual/configuration_option.md">Configuration option</a></p>
  86. <h4 id="optionvalue">option:value</h4>
  87. <ul>
  88. <li>Get the value of the option</li>
  89. </ul>
  90. <h4 id="optionname">option:name</h4>
  91. <ul>
  92. <li>Get the name of the option</li>
  93. </ul>
  94. <h4 id="optionget">option:get</h4>
  95. <ul>
  96. <li>Get the values of the option by name</li>
  97. </ul>
  98. <pre><code class="lang-lua">-- get the links
  99. option:get("links")
  100. -- get the defined macros
  101. option:get("defines")
  102. </code></pre>
  103. <h4 id="optionset">option:set</h4>
  104. <ul>
  105. <li>Set the values of the option by name (If you just want to add values use <a href="#optionadd">option:add</a>)</li>
  106. </ul>
  107. <pre><code class="lang-lua">-- set the links
  108. option:set("links", "sdl2")
  109. -- set the defined macros
  110. option:set("defines", "SDL_MAIN_HANDLED")
  111. -- set configvar
  112. option:set("configvar", option:name(), option:value(), {quote = false})
  113. </code></pre>
  114. <h4 id="optionadd">option:add</h4>
  115. <ul>
  116. <li>Add to the values of the option by name</li>
  117. </ul>
  118. <pre><code class="lang-lua">-- add links
  119. option:add("links", "sdl2")
  120. -- add defined macros
  121. option:add("defines", "SDL_MAIN_HANDLED")
  122. </code></pre>
  123. <p>!> The document here is still in progress, please be patient, you can also speed up the update of the document by sponsoring or submiting pr</p>
  124. </article>
  125. </body>
  126. </html>