/xbmc/visualizations/Vortex/angelscript/docs/manual/doc_addon_dict.html

http://github.com/xbmc/xbmc · HTML · 80 lines · 73 code · 6 blank · 1 comment · 0 complexity · 9dbccdc77da523fd99dbff34d5fdcd83 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
    3. 

  3. <title>AngelScript: dictionary object</title>
    4. 

  4. <link href="tabs.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="doxygen.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <!-- Generated by Doxygen 1.5.9 -->
    8. 

  8. <div class="contents">
    9. 

  9. <h1><a class="anchor" name="doc_addon_dict">dictionary object </a></h1><b>Path:</b> /sdk/add_on/scriptdictionary/<p>
    10. 

  10. The dictionary object maps string values to values or objects of other types.<p>
    11. 

  11. Register with <code>RegisterScriptDictionary(asIScriptEngine*)</code>.<h2><a class="anchor" name="doc_addon_dict_1">
    12. 

  12. Public C++ interface</a></h2>
    13. 

  13. <div class="fragment"><pre class="fragment"><span class="keyword">class </span>CScriptDictionary
    14. 

  14. {
    15. 

  15. <span class="keyword">public</span>:
    16. 

  16.   <span class="comment">// Memory management</span>
    17. 

  17.   CScriptDictionary(<a class="code" href="classas_i_script_engine.html" title="The engine interface.">asIScriptEngine</a> *engine);
    18. 

  18.   <span class="keywordtype">void</span> AddRef();
    19. 

  19.   <span class="keywordtype">void</span> Release();
    20. 

  20. 

  21.   <span class="comment">// Sets/Gets a variable type value for a key</span>
    22. 

  22.   <span class="keywordtype">void</span> Set(<span class="keyword">const</span> std::string &amp;key, <span class="keywordtype">void</span> *value, <span class="keywordtype">int</span> typeId);
    23. 

  23.   <span class="keywordtype">bool</span> Get(<span class="keyword">const</span> std::string &amp;key, <span class="keywordtype">void</span> *value, <span class="keywordtype">int</span> typeId) <span class="keyword">const</span>;
    24. 

  24. 

  25.   <span class="comment">// Sets/Gets an integer number value for a key</span>
    26. 

  26.   <span class="keywordtype">void</span> Set(<span class="keyword">const</span> std::string &amp;key, <a class="code" href="angelscript_8h.html#a8044b56ee56e2350b06f1e7207b43df" title="64 bit integer">asINT64</a> &amp;value);
    27. 

  27.   <span class="keywordtype">bool</span> Get(<span class="keyword">const</span> std::string &amp;key, <a class="code" href="angelscript_8h.html#a8044b56ee56e2350b06f1e7207b43df" title="64 bit integer">asINT64</a> &amp;value) <span class="keyword">const</span>;
    28. 

  28. 

  29.   <span class="comment">// Sets/Gets a real number value for a key</span>
    30. 

  30.   <span class="keywordtype">void</span> Set(<span class="keyword">const</span> std::string &amp;key, <span class="keywordtype">double</span> &amp;value);
    31. 

  31.   <span class="keywordtype">bool</span> Get(<span class="keyword">const</span> std::string &amp;key, <span class="keywordtype">double</span> &amp;value) <span class="keyword">const</span>;
    32. 

  32. 

  33.   <span class="comment">// Returns true if the key is set</span>
    34. 

  34.   <span class="keywordtype">bool</span> Exists(<span class="keyword">const</span> std::string &amp;key) <span class="keyword">const</span>;
    35. 

  35.   
    36. 

  36.   <span class="comment">// Deletes the key</span>
    37. 

  37.   <span class="keywordtype">void</span> Delete(<span class="keyword">const</span> std::string &amp;key);
    38. 

  38.   
    39. 

  39.   <span class="comment">// Deletes all keys</span>
    40. 

  40.   <span class="keywordtype">void</span> DeleteAll();
    41. 

  41. };
    42. 

  42. </pre></div><h2><a class="anchor" name="doc_addon_dict_2">
    43. 

  43. Public script interface</a></h2>
    44. 

  44. <pre>
    45. 

  45.   class dictionary
    46. 

  46.   {
    47. 

  47.     void set(const string &amp;in key, ? &amp;in value);
    48. 

  48.     bool get(const string &amp;in value, ? &amp;out value) const;</pre><p>
    49. 

  49. <pre>    void set(const string &amp;in key, int64 &amp;in value);
    50. 

  50.     bool get(const string &amp;in key, int64 &amp;out value) const;</pre><p>
    51. 

  51. <pre>    void set(const string &amp;in key, double &amp;in value);
    52. 

  52.     bool get(const string &amp;in key, double &amp;out value) const;</pre><p>
    53. 

  53. <pre>    bool exists(const string &amp;in key) const;
    54. 

  54.     void delete(const string &amp;in key);
    55. 

  55.     void deleteAll();
    56. 

  56.   }
    57. 

  57. </pre><h2><a class="anchor" name="doc_addon_dict_3">
    58. 

  58. Script example</a></h2>
    59. 

  59. <pre>
    60. 

  60.   dictionary dict;
    61. 

  61.   obj object;
    62. 

  62.   obj @handle;</pre><p>
    63. 

  63. <pre>  dict.set("one", 1);
    64. 

  64.   dict.set("object", object);
    65. 

  65.   dict.set("handle", @handle);</pre><p>
    66. 

  66. <pre>  if( dict.exists("one") )
    67. 

  67.   {
    68. 

  68.     bool found = dict.get("handle", @handle);
    69. 

  69.     if( found )
    70. 

  70.     {
    71. 

  71.       dict.delete("object");
    72. 

  72.     }
    73. 

  73.   }</pre><p>
    74. 

  74. <pre>  dict.deleteAll();
    75. 

  75. </pre> </div>
    76. 

  76. <hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 16 19:34:50 2009 for AngelScript by&nbsp;
    77. 

  77. <a href="http://www.doxygen.org/index.html">
    78. 

  78. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
    79. 

  79. </body>
    80. 

  80. </html>
    81.