Skip to content

Commit

Permalink
Fir error, update NaturalDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sparker95 committed Jun 6, 2019
1 parent cbd48c5 commit a92f10a
Show file tree
Hide file tree
Showing 214 changed files with 963 additions and 265 deletions.
2 changes: 1 addition & 1 deletion Docs/HTML/classes/SQF/AI/AICommander-Summary.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Docs/HTML/classes/SQF/AI/AICommander-SummaryToolTips.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 17 additions & 7 deletions Docs/HTML/classes/SQF/AI/AICommander.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
<div class="CBody"><p>Returns AICommander object that commands given side</p><p>Parameters: _side</p><table class="CDefinitionList"><tr><td class="CDLEntry">_side</td><td class="CDLDefinition"><p>side</p></td></tr></table><p>Returns: <a href="../../../index.html#SQFClass:AI.AICommander" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,71);" onmouseout="NDContentPage.OnLinkMouseOut(event);" >AICommander</a></p></div>
</div>

<a name="onTargetClusterCreated"></a><a name="Topic52"></a><div class="CTopic TFunction LSQF">
<div class="CTitle">onTargetClusterCreated</div>
<div class="CBody"><p>Gets called on creation of a totally new target cluster</p><p>Parameters: _tc</p><table class="CDefinitionList"><tr><td class="CDLEntry">_tc</td><td class="CDLDefinition"><p>the new target cluster</p></td></tr></table><p>Returns: nil</p></div>
<a name="(static)getCmdrStrategy"></a><a name="Topic276"></a><div class="CTopic TFunction LSQF">
<div class="CTitle">(static)getCmdrStrategy</div>
<div class="CBody"><p>Returns Strategy the cmdr of the specified side is using.</p><p>Parameters: _side</p><table class="CDefinitionList"><tr><td class="CDLEntry">_side</td><td class="CDLDefinition"><p>side</p></td></tr></table><p>Returns: &lt;CmdrStrategy&gt;</p></div>
</div>

<a name="onTargetClusterSplitted"></a><a name="Topic76"></a><div class="CTopic TFunction LSQF">
Expand All @@ -47,9 +47,14 @@
<div class="CBody"><p>Returns a target cluster with specified ID</p><p>Parameters: _ID</p><table class="CDefinitionList"><tr><td class="CDLEntry">_ID</td><td class="CDLDefinition"><p>ID of the target cluster</p></td></tr></table><p>Returns: target cluster structure or [] if nothing was found</p></div>
</div>

<a name="allocateUnitsGroundQRF"></a><a name="Topic59"></a><div class="CTopic TFunction LSQF">
<div class="CTitle">allocateUnitsGroundQRF</div>
<div class="CBody"><p>Tries to find a location to send units from</p><p>Parameters: _pos, _requiredEff</p><table class="CDefinitionList"><tr><td class="CDLEntry">_pos</td><td class="CDLDefinition"><p>position where to send QRF to</p></td></tr><tr><td class="CDLEntry">_requiredEff</td><td class="CDLDefinition"><p>efficiency vector</p></td></tr></table><p>Returns: [_location, _garrison, _units, _groupsAndGroups]</p></div>
<a name="getThreat"></a><a name="Topic297"></a><div class="CTopic TFunction LSQF">
<div class="CTitle">getThreat</div>
<div class="CBody"><p>Get estimated threat at a particular position</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">_pos</td><td class="CDLDefinition"><p>&lt;position&gt;</p></td></tr><tr><td class="CDLEntry">Returns: Number</td><td class="CDLDefinition"><p>threat at _pos</p></td></tr></table></div>
</div>

<a name="getActivity"></a><a name="Topic322"></a><div class="CTopic TFunction LSQF">
<div class="CTitle">getActivity</div>
<div class="CBody"><p>Get enemy (to this cmdr) activity in an area</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">_pos</td><td class="CDLDefinition"><p>&lt;position&gt;</p></td></tr><tr><td class="CDLEntry">_radius</td><td class="CDLDefinition"><p>&lt;number&gt;</p></td></tr><tr><td class="CDLEntry">Returns: Number</td><td class="CDLDefinition"><p>max activity in radius</p></td></tr></table></div>
</div>

<a name="registerGarrison"></a><a name="Topic77"></a><div class="CTopic TFunction LSQF">
Expand All @@ -62,9 +67,14 @@
<div class="CBody"><p>Registers a location to be known by this AICommander</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">_loc</td><td class="CDLDefinition"><p><a href="../../../index.html#SQFClass:Location" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,277);" onmouseout="NDContentPage.OnLinkMouseOut(event);" >Location</a></p></td></tr></table><p>Returns: nil</p></div>
</div>

<a name="unregisterGarrison"></a><a name="Topic537"></a><div class="CTopic TFunction LSQF last">
<a name="unregisterGarrison"></a><a name="Topic537"></a><div class="CTopic TFunction LSQF">
<div class="CTitle">unregisterGarrison</div>
<div class="CBody"><p>Unregisters a garrison from this AICommander</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">_gar</td><td class="CDLDefinition"><p><a href="../../../index.html#SQFClass:Garrison" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,208);" onmouseout="NDContentPage.OnLinkMouseOut(event);" >Garrison</a></p></td></tr></table><p>Returns: nil</p></div>
</div>

<a name="registerIntelCommanderAction"></a><a name="Topic323"></a><div class="CTopic TFunction LSQF last">
<div class="CTitle">registerIntelCommanderAction</div>
<div class="CBody"><p>Registers a piece of intel on an action that this Commander owns.&nbsp; Parameters: _intel - &lt;IntelCommanderAction&gt;</p><p>Returns: nil</p></div>
</div>

</body></html>

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions Docs/HTML/classes/SQF/ActionGroup/ActionGroupArrest.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ActionGroupArrest</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css" /><script type="text/javascript" src="../../../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../../../styles/");</script></head>

<!-- Generated by Natural Docs, version 2.0.2 -->

<!-- saved from url=(0016)http://localhost -->

<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">

<a name="Topic665"></a><div class="CTopic TClass LSQF first">
<div class="CTitle"><span class="Qualifier">ActionGroup.</span>&#8203;ActionGroupArrest</div>
<div class="CBody"><p>Tell group to arrest a suspicious player unit.</p></div>
</div>

</body></html>
2 changes: 1 addition & 1 deletion Docs/HTML/classes/SQF/ClientMapUI-Summary.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Docs/HTML/classes/SQF/ClientMapUI-SummaryToolTips.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 34 additions & 0 deletions Docs/HTML/classes/SQF/ClientMapUI.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,38 @@
<div class="CBody"><p>Singleton class that performs things related to map user interface</p></div>
</div>

<a name="Functions"></a><a name="Topic344"></a><div class="CTopic TGroup LSQF">
<div class="CTitle">Functions</div>
</div>

<a name="onMouseEnter"></a><a name="Topic346"></a><div class="CTopic TFunction LSQF">
<div class="CTitle">onMouseEnter</div>
<div class="CBody"><p>Description: Called when the mouse cursor enters the control.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">0: _control</td><td class="CDLDefinition"><p>Reference to the control which called this method</p></td></tr></table></div>
</div>

<a name="onMouseExit"></a><a name="Topic643"></a><div class="CTopic TFunction LSQF">
<div class="CTitle">onMouseExit</div>
<div class="CBody"><p>Description: Called when the mouse cursor exits the control.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">0: _control</td><td class="CDLDefinition"><p>Reference to the control which called this method</p></td></tr></table></div>
</div>

<a name="onLBSelChanged"></a><a name="Topic661"></a><div class="CTopic TFunction LSQF">
<div class="CTitle">onLBSelChanged</div>
<div class="CBody"><p>Description: Called when the selection inside the listbox has changed.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">0: _control</td><td class="CDLDefinition"><p>Reference to the control which called this method</p></td></tr></table></div>
</div>

<a name="onMouseClickElsewhere"></a><a name="Topic662"></a><div class="CTopic TFunction LSQF">
<div class="CTitle">onMouseClickElsewhere</div>
<div class="CBody"><p>Description: Gets called when user clicks on the map not on a marker.</p></div>
</div>

<a name="clearListNBox"></a><a name="Topic663"></a><div class="CTopic TFunction LSQF">
<div class="CTitle">clearListNBox</div>
<div class="CBody"><p>Description</p><p>Returns: nil</p></div>
</div>

<a name="onMapMarkerMouseButtonDown"></a><a name="Topic664"></a><div class="CTopic TFunction LSQF last">
<div class="CTitle">onMapMarkerMouseButtonDown</div>
<div class="CBody"><p>Gets called when user clicks on a map marker</p><p>Parameters: _mapMarker, _intel</p><p>Returns: nil</p></div>
</div>

</body></html>
1 change: 0 additions & 1 deletion Docs/HTML/classes/SQF/GameModeBase-Summary.js

This file was deleted.

1 change: 0 additions & 1 deletion Docs/HTML/classes/SQF/GameModeBase-SummaryToolTips.js

This file was deleted.

24 changes: 0 additions & 24 deletions Docs/HTML/classes/SQF/GameModeBase.html

This file was deleted.

1 change: 1 addition & 0 deletions Docs/HTML/classes/SQF/GarbageCollector-Summary.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Docs/HTML/classes/SQF/GarbageCollector-SummaryToolTips.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Docs/HTML/classes/SQF/GarbageCollector-ToolTips.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit a92f10a

Please sign in to comment.