Mluti-Agent_simulation/3DModule/Assets/Plugins/Zibra/Common/Documentation/APIReference/a00586.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Zibra Effects: Effects Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js.txt"></script>
<script type="text/javascript" src="dynsections.js.txt"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js.txt"></script>
<script type="text/javascript" src="search/search.js.txt"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Zibra Effects
   </div>
   <div id="projectbrief">Real-time Simulated Visual Effects</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js.txt"></script>
<script type="text/javascript" src="menu.js.txt"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="a00335.html">com</a></li><li class="navelem"><a class="el" href="a00336.html">zibra</a></li><li class="navelem"><a class="el" href="a00337.html">common</a></li><li class="navelem"><a class="el" href="a00586.html">Effects</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="a00583.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Effects Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Class containing static data about currently installed version of Zibra Effects.  
 <a href="a00586.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a31dfd27659ebf53d2b24072148dd2aa4"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00586.html#a31dfd27659ebf53d2b24072148dd2aa4">VersionStandard</a> = &quot;2.1.0.0&quot;</td></tr>
<tr class="memdesc:a31dfd27659ebf53d2b24072148dd2aa4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Zibra Effects version in form that follow c# versioning standard (d.d.d.d).  <br /></td></tr>
<tr class="separator:a31dfd27659ebf53d2b24072148dd2aa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1fcfb57c05b324c820eab539569b409"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00586.html#ac1fcfb57c05b324c820eab539569b409">Version</a> = &quot;2.1.0&quot;</td></tr>
<tr class="memdesc:ac1fcfb57c05b324c820eab539569b409"><td class="mdescLeft">&#160;</td><td class="mdescRight">Zibra Effects version in human readable form.  <br /></td></tr>
<tr class="separator:ac1fcfb57c05b324c820eab539569b409"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ba3e575e0db0b2a1dd01515d7f21ef7"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00586.html#a7ba3e575e0db0b2a1dd01515d7f21ef7">IsPreReleaseVersion</a> = false</td></tr>
<tr class="memdesc:a7ba3e575e0db0b2a1dd01515d7f21ef7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals whether current Zibra Effects version is pre-release one.  <br /></td></tr>
<tr class="separator:a7ba3e575e0db0b2a1dd01515d7f21ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7025e1bed7c9a62c9260d62199dd2344"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00586.html#a7025e1bed7c9a62c9260d62199dd2344">DistributionType</a> = &quot;Subscription&quot;</td></tr>
<tr class="memdesc:a7025e1bed7c9a62c9260d62199dd2344"><td class="mdescLeft">&#160;</td><td class="mdescRight">Distribution method used with this plugin.  <br /></td></tr>
<tr class="separator:a7025e1bed7c9a62c9260d62199dd2344"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd5d6a1fb85346c5533371f5a19d4862"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00586.html#afd5d6a1fb85346c5533371f5a19d4862">BaseMenuBarPath</a> = &quot;Zibra <a class="el" href="a00586.html">Effects</a>/&quot;</td></tr>
<tr class="memdesc:afd5d6a1fb85346c5533371f5a19d4862"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base path used by all menu bar items in Zibra Effects.  <br /></td></tr>
<tr class="separator:afd5d6a1fb85346c5533371f5a19d4862"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc71fd0c3cf09c4a94e7de0cf96fdf09"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00586.html#acc71fd0c3cf09c4a94e7de0cf96fdf09">LiquidGameObjectMenuPath</a> = &quot;GameObject/Zibra <a class="el" href="a00586.html">Effects</a> - Liquid/&quot;</td></tr>
<tr class="memdesc:acc71fd0c3cf09c4a94e7de0cf96fdf09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base path used by all Liquid object menu items in Zibra Effects.  <br /></td></tr>
<tr class="separator:acc71fd0c3cf09c4a94e7de0cf96fdf09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85f3b3eb13bdf0f2d512c25e6ab69c73"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00586.html#a85f3b3eb13bdf0f2d512c25e6ab69c73">SmokeAndFireGameObjectMenuPath</a> = &quot;GameObject/Zibra <a class="el" href="a00586.html">Effects</a> - Smoke and Fire/&quot;</td></tr>
<tr class="memdesc:a85f3b3eb13bdf0f2d512c25e6ab69c73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base path used by all Smoke &amp; Fire object menu items in Zibra Effects.  <br /></td></tr>
<tr class="separator:a85f3b3eb13bdf0f2d512c25e6ab69c73"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class containing static data about currently installed version of Zibra Effects. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a31dfd27659ebf53d2b24072148dd2aa4" name="a31dfd27659ebf53d2b24072148dd2aa4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31dfd27659ebf53d2b24072148dd2aa4">&#9670;&#160;</a></span>VersionStandard</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const string VersionStandard = &quot;2.1.0.0&quot;</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Zibra Effects version in form that follow c# versioning standard (d.d.d.d). </p>
<p>This is the version that liquid assemblies will have </p>

</div>
</div>
<a id="ac1fcfb57c05b324c820eab539569b409" name="ac1fcfb57c05b324c820eab539569b409"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1fcfb57c05b324c820eab539569b409">&#9670;&#160;</a></span>Version</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const string Version = &quot;2.1.0&quot;</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Zibra Effects version in human readable form. </p>
<p>This is the version that used in UI/Diagnostics info/etc. </p>
<p>May contain arbitrary text depending on the version. </p>

</div>
</div>
<a id="a7ba3e575e0db0b2a1dd01515d7f21ef7" name="a7ba3e575e0db0b2a1dd01515d7f21ef7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ba3e575e0db0b2a1dd01515d7f21ef7">&#9670;&#160;</a></span>IsPreReleaseVersion</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const bool IsPreReleaseVersion = false</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Signals whether current Zibra Effects version is pre-release one. </p>
<p>Release packages always have this set to false. Will only be true for Early Access and similar packages. </p>

</div>
</div>
<a id="a7025e1bed7c9a62c9260d62199dd2344" name="a7025e1bed7c9a62c9260d62199dd2344"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7025e1bed7c9a62c9260d62199dd2344">&#9670;&#160;</a></span>DistributionType</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const string DistributionType = &quot;Subscription&quot;</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Distribution method used with this plugin. </p>

</div>
</div>
<a id="afd5d6a1fb85346c5533371f5a19d4862" name="afd5d6a1fb85346c5533371f5a19d4862"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd5d6a1fb85346c5533371f5a19d4862">&#9670;&#160;</a></span>BaseMenuBarPath</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const string BaseMenuBarPath = &quot;Zibra <a class="el" href="a00586.html">Effects</a>/&quot;</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Base path used by all menu bar items in Zibra Effects. </p>

</div>
</div>
<a id="acc71fd0c3cf09c4a94e7de0cf96fdf09" name="acc71fd0c3cf09c4a94e7de0cf96fdf09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc71fd0c3cf09c4a94e7de0cf96fdf09">&#9670;&#160;</a></span>LiquidGameObjectMenuPath</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const string LiquidGameObjectMenuPath = &quot;GameObject/Zibra <a class="el" href="a00586.html">Effects</a> - Liquid/&quot;</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Base path used by all Liquid object menu items in Zibra Effects. </p>

</div>
</div>
<a id="a85f3b3eb13bdf0f2d512c25e6ab69c73" name="a85f3b3eb13bdf0f2d512c25e6ab69c73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85f3b3eb13bdf0f2d512c25e6ab69c73">&#9670;&#160;</a></span>SmokeAndFireGameObjectMenuPath</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const string SmokeAndFireGameObjectMenuPath = &quot;GameObject/Zibra <a class="el" href="a00586.html">Effects</a> - Smoke and Fire/&quot;</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Base path used by all Smoke &amp; Fire object menu items in Zibra Effects. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Assets/Plugins/Zibra/Common/Effects.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>