Difference between revisions of "RallyPoint"

From cluster wiki
Jump to navigation Jump to search
Line 18: Line 18:
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Groups:</dt>
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Groups:</dt>
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
Gameplay Utility Functions: Eric's Mission Framework
Gameplay: Eric's Mission Framework
</div></dd>
</div></dd>
  </dl>  
  </dl>  
Line 28: Line 28:
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Syntax:</dt>
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Syntax:</dt>
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
[unit, cooldown, physicalObject] call '''EMF_fnc_rallyPoint'''
[unit, cooldown, object] call '''emf_gameplay_fnc_rallyPoint'''
</div></dd>
</div></dd>


Line 45: Line 45:


<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
physicalObject: String - (Optional) classname of the object to use.[Default: "Misc_backpackheap_EP1"]
object: String - (Optional) classname of the object to use.[Default: "Misc_backpackheap_EP1"]
</div></dd>
</div></dd>


Line 61: Line 61:
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Example 1:</dt>
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Example 1:</dt>
<dd style="width:90%;padding:.3em .3em .3em 7em;"><code style="border:#25A1A1 dashed 1px;display:block;">
<dd style="width:90%;padding:.3em .3em .3em 7em;"><code style="border:#25A1A1 dashed 1px;display:block;">
[player, 5] call '''EMF_fnc_rallyPoint''';
[player, 5] call '''emf_gameplay_fnc_rallyPoint''';
</code></dd>
</code></dd>


Line 67: Line 67:
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Example 2:</dt>
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Example 2:</dt>
<dd style="width:90%;padding:.3em .3em .3em 7em;"><code style="border:#25A1A1 dashed 1px;display:block;">
<dd style="width:90%;padding:.3em .3em .3em 7em;"><code style="border:#25A1A1 dashed 1px;display:block;">
["SL", 5, "Vysilacka"] call '''EMF_fnc_rallypoint''';
["SL", 5, "Vysilacka"] call '''emf_gameplay_fnc_rallyPoint''';
</code></dd>
</code></dd>


Line 73: Line 73:
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Example 3:</dt>
<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Example 3:</dt>
<dd style="width:90%;padding:.3em .3em .3em 7em;"><code style="border:#25A1A1 dashed 1px;display:block;">
<dd style="width:90%;padding:.3em .3em .3em 7em;"><code style="border:#25A1A1 dashed 1px;display:block;">
<nowiki>[[Unit1, Unit2, Unit3], 15]</nowiki> call '''EMF_fnc_rallypoint''';
<nowiki>[[Unit1, Unit2, Unit3], 15]</nowiki> call '''emf_gameplay_fnc_rallyPoint''';
</code></dd>
</code></dd>



Revision as of 15:26, 18 March 2022

Description
Description:

This function creates a spawnpoint system similar to Squad's rally points. It must be run locally (eg. from initPlayerLocal.sqf).

Execution:

call

Groups:

Gameplay: Eric's Mission Framework

Syntax
Syntax:

[unit, cooldown, object] call emf_gameplay_fnc_rallyPoint

Parameters:

unit:

  • Object - Unit to apply to.
  • Array - Units to apply to.
  • String - role to apply to.

cooldown: Number - (Optional) The cooldown between rally placements.[Default: 10]

object: String - (Optional) classname of the object to use.[Default: "Misc_backpackheap_EP1"]

Return Value:

Boolean - Returns true on success.

Examples
Example 1:
[player, 5] call emf_gameplay_fnc_rallyPoint;
Example 2:
["SL", 5, "Vysilacka"] call emf_gameplay_fnc_rallyPoint;
Example 3:
[[Unit1, Unit2, Unit3], 15] call emf_gameplay_fnc_rallyPoint;
Additional Information
See also:


Notes