weyne/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-08-15 10:47:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
MOOSE/docs/Documentation/Protect.html
FlightControl_Master ddf45d8485 Documentation and new moose.lua for dynamic loading.
2017-10-10 11:07:43 +02:00

757 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<link rel="stylesheet" href="stylesheet.css" type="text/css"/>
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div>
<div id="main">
<div id="navigation">
<h2>Modules</h2>
<ul><li>
<a href="index.html">index</a>
</li></ul>
<ul>
<li><a href="AI_A2A.html">AI_A2A</a></li>
<li><a href="AI_A2A_Cap.html">AI_A2A_Cap</a></li>
<li><a href="AI_A2A_Dispatcher.html">AI_A2A_Dispatcher</a></li>
<li><a href="AI_A2A_GCI.html">AI_A2A_GCI</a></li>
<li><a href="AI_A2A_Patrol.html">AI_A2A_Patrol</a></li>
<li><a href="AI_Bai.html">AI_Bai</a></li>
<li><a href="AI_Balancer.html">AI_Balancer</a></li>
<li><a href="AI_Cap.html">AI_Cap</a></li>
<li><a href="AI_Cas.html">AI_Cas</a></li>
<li><a href="AI_Formation.html">AI_Formation</a></li>
<li><a href="AI_Patrol.html">AI_Patrol</a></li>
<li><a href="Account.html">Account</a></li>
<li><a href="Airbase.html">Airbase</a></li>
<li><a href="AirbasePolice.html">AirbasePolice</a></li>
<li><a href="Assign.html">Assign</a></li>
<li><a href="Base.html">Base</a></li>
<li><a href="Cargo.html">Cargo</a></li>
<li><a href="CleanUp.html">CleanUp</a></li>
<li><a href="Client.html">Client</a></li>
<li><a href="CommandCenter.html">CommandCenter</a></li>
<li><a href="Controllable.html">Controllable</a></li>
<li><a href="DCSAirbase.html">DCSAirbase</a></li>
<li><a href="DCSCoalitionObject.html">DCSCoalitionObject</a></li>
<li><a href="DCSCommand.html">DCSCommand</a></li>
<li><a href="DCSController.html">DCSController</a></li>
<li><a href="DCSGroup.html">DCSGroup</a></li>
<li><a href="DCSObject.html">DCSObject</a></li>
<li><a href="DCSTask.html">DCSTask</a></li>
<li><a href="DCSTypes.html">DCSTypes</a></li>
<li><a href="DCSUnit.html">DCSUnit</a></li>
<li><a href="DCSVec3.html">DCSVec3</a></li>
<li><a href="DCSWorld.html">DCSWorld</a></li>
<li><a href="DCSZone.html">DCSZone</a></li>
<li><a href="DCScountry.html">DCScountry</a></li>
<li><a href="DCStimer.html">DCStimer</a></li>
<li><a href="DCStrigger.html">DCStrigger</a></li>
<li><a href="Database.html">Database</a></li>
<li><a href="Designate.html">Designate</a></li>
<li><a href="Detection.html">Detection</a></li>
<li><a href="DetectionManager.html">DetectionManager</a></li>
<li><a href="Escort.html">Escort</a></li>
<li><a href="Event.html">Event</a></li>
<li><a href="Fsm.html">Fsm</a></li>
<li><a href="Goal.html">Goal</a></li>
<li><a href="Group.html">Group</a></li>
<li><a href="Identifiable.html">Identifiable</a></li>
<li><a href="Menu.html">Menu</a></li>
<li><a href="Message.html">Message</a></li>
<li><a href="MissileTrainer.html">MissileTrainer</a></li>
<li><a href="Mission.html">Mission</a></li>
<li><a href="Movement.html">Movement</a></li>
<li><a href="Object.html">Object</a></li>
<li><a href="Point.html">Point</a></li>
<li><a href="Positionable.html">Positionable</a></li>
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
<li><a href="Process_Pickup.html">Process_Pickup</a></li>
<li>Protect</li>
<li><a href="Radio.html">Radio</a></li>
<li><a href="Rat.html">Rat</a></li>
<li><a href="Route.html">Route</a></li>
<li><a href="Scenery.html">Scenery</a></li>
<li><a href="ScheduleDispatcher.html">ScheduleDispatcher</a></li>
<li><a href="Scheduler.html">Scheduler</a></li>
<li><a href="Scoring.html">Scoring</a></li>
<li><a href="Sead.html">Sead</a></li>
<li><a href="Set.html">Set</a></li>
<li><a href="Settings.html">Settings</a></li>
<li><a href="Smoke.html">Smoke</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="SpawnStatic.html">SpawnStatic</a></li>
<li><a href="Spot.html">Spot</a></li>
<li><a href="Static.html">Static</a></li>
<li><a href="StaticObject.html">StaticObject</a></li>
<li><a href="Task.html">Task</a></li>
<li><a href="TaskZoneCapture.html">TaskZoneCapture</a></li>
<li><a href="Task_A2A.html">Task_A2A</a></li>
<li><a href="Task_A2A_Dispatcher.html">Task_A2A_Dispatcher</a></li>
<li><a href="Task_A2G.html">Task_A2G</a></li>
<li><a href="Task_A2G_Dispatcher.html">Task_A2G_Dispatcher</a></li>
<li><a href="Task_Cargo.html">Task_Cargo</a></li>
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
<li><a href="Unit.html">Unit</a></li>
<li><a href="UserFlag.html">UserFlag</a></li>
<li><a href="UserSound.html">UserSound</a></li>
<li><a href="Utils.html">Utils</a></li>
<li><a href="Zone.html">Zone</a></li>
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
<li><a href="env.html">env</a></li>
<li><a href="land.html">land</a></li>
<li><a href="routines.html">routines</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>Protect</code></h1>
<p><strong>Functional</strong> -- The PROTECT class handles the protection of objects, which can be zones, units, scenery.</p>
<hr/>
<h3>Author: <strong>Sven Van de Velde (FlightControl)</strong></h3>
<h3>Contributions: <strong>MillerTime</strong></h3>
<hr/>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#PROTECT">PROTECT</a></td>
<td class="summary">
<h1>PROTECT, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
</td>
</tr>
</table>
<h2><a id="#(PROTECT)">Type <code>PROTECT</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).AreProtectStaticsAlive">PROTECT:AreProtectStaticsAlive()</a></td>
<td class="summary">
<p>Check if the statics are still alive.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).AreProtectUnitsAlive">PROTECT:AreProtectUnitsAlive()</a></td>
<td class="summary">
<p>Check if the units are still alive.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).Coalition">PROTECT.Coalition</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).Flare">PROTECT:Flare(FlareColor)</a></td>
<td class="summary">
<p>Flare.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).GetCoalition">PROTECT:GetCoalition()</a></td>
<td class="summary">
<p>Get the owning coalition of the zone.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).GetCoalitionName">PROTECT:GetCoalitionName()</a></td>
<td class="summary">
<p>Get the owning coalition name of the zone.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).GetProtectZone">PROTECT:GetProtectZone()</a></td>
<td class="summary">
<p>Get the ProtectZone</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).GetProtectZoneName">PROTECT:GetProtectZoneName()</a></td>
<td class="summary">
<p>Get the name of the ProtectZone</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).IsAttacked">PROTECT:IsAttacked()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).IsCaptureUnitInZone">PROTECT:IsCaptureUnitInZone()</a></td>
<td class="summary">
<p>Check if there is a capture unit in the zone.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).IsCaptured">PROTECT:IsCaptured()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).IsEmpty">PROTECT:IsEmpty()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).IsGuarded">PROTECT:IsGuarded()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).Mark">PROTECT:Mark()</a></td>
<td class="summary">
<p>Mark.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).MarkBlue">PROTECT.MarkBlue</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).MarkRed">PROTECT.MarkRed</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).SetCoalition">PROTECT:SetCoalition(Coalition)</a></td>
<td class="summary">
<p>Set the owning coalition of the zone.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).Smoke">PROTECT:Smoke(SmokeColor)</a></td>
<td class="summary">
<p>Smoke.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).SmokeColor">PROTECT.SmokeColor</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).SmokeTime">PROTECT.SmokeTime</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).StatusCoalition">PROTECT:StatusCoalition()</a></td>
<td class="summary">
<p>Check status Coalition ownership.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).StatusSmoke">PROTECT:StatusSmoke()</a></td>
<td class="summary">
<p>Check status Smoke.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).StatusZone">PROTECT:StatusZone()</a></td>
<td class="summary">
<p>Check status Zone.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).onafterStart">PROTECT:onafterStart()</a></td>
<td class="summary">
<p>Bound.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).onenterAttacked">PROTECT:onenterAttacked()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).onenterCaptured">PROTECT:onenterCaptured()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).onenterEmpty">PROTECT:onenterEmpty()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(PROTECT).onenterGuarded">PROTECT:onenterGuarded()</a></td>
<td class="summary">
<p>Bound.</p>
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(PROTECT)">#PROTECT</a></em>
<a id="PROTECT" >
<strong>PROTECT</strong>
</a>
</dt>
<dd>
<h1>PROTECT, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
</dd>
</dl>
<h2><a id="#(Protect)" >Type <code>Protect</code></a></h2>
<h2><a id="#(PROTECT)" >Type <code>PROTECT</code></a></h2>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(PROTECT).AreProtectStaticsAlive" >
<strong>PROTECT:AreProtectStaticsAlive()</strong>
</a>
</dt>
<dd>
<p>Check if the statics are still alive.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).AreProtectUnitsAlive" >
<strong>PROTECT:AreProtectUnitsAlive()</strong>
</a>
</dt>
<dd>
<p>Check if the units are still alive.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROTECT).Coalition" >
<strong>PROTECT.Coalition</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).Flare" >
<strong>PROTECT:Flare(FlareColor)</strong>
</a>
</dt>
<dd>
<p>Flare.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="##(SMOKECOLOR.Color)">#SMOKECOLOR.Color</a> FlareColor </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).GetCoalition" >
<strong>PROTECT:GetCoalition()</strong>
</a>
</dt>
<dd>
<p>Get the owning coalition of the zone.</p>
<h3>Return value</h3>
<p><em><a href="DCSCoalition.DCSCoalition.html##(coalition)">DCSCoalition.DCSCoalition#coalition</a>:</em>
Coalition.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).GetCoalitionName" >
<strong>PROTECT:GetCoalitionName()</strong>
</a>
</dt>
<dd>
<p>Get the owning coalition name of the zone.</p>
<h3>Return value</h3>
<p><em>#string:</em>
Coalition name.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).GetProtectZone" >
<strong>PROTECT:GetProtectZone()</strong>
</a>
</dt>
<dd>
<p>Get the ProtectZone</p>
<h3>Return value</h3>
<p><em><a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).GetProtectZoneName" >
<strong>PROTECT:GetProtectZoneName()</strong>
</a>
</dt>
<dd>
<p>Get the name of the ProtectZone</p>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).IsAttacked" >
<strong>PROTECT:IsAttacked()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).IsCaptureUnitInZone" >
<strong>PROTECT:IsCaptureUnitInZone()</strong>
</a>
</dt>
<dd>
<p>Check if there is a capture unit in the zone.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).IsCaptured" >
<strong>PROTECT:IsCaptured()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).IsEmpty" >
<strong>PROTECT:IsEmpty()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).IsGuarded" >
<strong>PROTECT:IsGuarded()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).Mark" >
<strong>PROTECT:Mark()</strong>
</a>
</dt>
<dd>
<p>Mark.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROTECT).MarkBlue" >
<strong>PROTECT.MarkBlue</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROTECT).MarkRed" >
<strong>PROTECT.MarkRed</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).SetCoalition" >
<strong>PROTECT:SetCoalition(Coalition)</strong>
</a>
</dt>
<dd>
<p>Set the owning coalition of the zone.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="DCSCoalition.DCSCoalition.html##(coalition)">DCSCoalition.DCSCoalition#coalition</a> Coalition </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).Smoke" >
<strong>PROTECT:Smoke(SmokeColor)</strong>
</a>
</dt>
<dd>
<p>Smoke.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="##(SMOKECOLOR.Color)">#SMOKECOLOR.Color</a> SmokeColor </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROTECT).SmokeColor" >
<strong>PROTECT.SmokeColor</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(PROTECT).SmokeTime" >
<strong>PROTECT.SmokeTime</strong>
</a>
</dt>
<dd>
<p>self.SmokeColor = nil</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).StatusCoalition" >
<strong>PROTECT:StatusCoalition()</strong>
</a>
</dt>
<dd>
<p>Check status Coalition ownership.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).StatusSmoke" >
<strong>PROTECT:StatusSmoke()</strong>
</a>
</dt>
<dd>
<p>Check status Smoke.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).StatusZone" >
<strong>PROTECT:StatusZone()</strong>
</a>
</dt>
<dd>
<p>Check status Zone.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).onafterStart" >
<strong>PROTECT:onafterStart()</strong>
</a>
</dt>
<dd>
<p>Bound.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).onenterAttacked" >
<strong>PROTECT:onenterAttacked()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).onenterCaptured" >
<strong>PROTECT:onenterCaptured()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).onenterEmpty" >
<strong>PROTECT:onenterEmpty()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(PROTECT).onenterGuarded" >
<strong>PROTECT:onenterGuarded()</strong>
</a>
</dt>
<dd>
<p>Bound.</p>
</dd>
</dl>
<h2><a id="#(PROTECT.__)" >Type <code>PROTECT.__</code></a></h2>
<h2><a id="#(SMOKECOLOR.Color)" >Type <code>SMOKECOLOR.Color</code></a></h2>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink