Difference between revisions of "Init (Kosher Arsenal)"

From cluster wiki
Jump to navigation Jump to search
Line 1: Line 1:
===Description===
<div style="padding:0.33em 2em;font-size:1.2em;font-weight:bold;display:block; border-bottom: #25A1A1 solid 1px; background-color:#E0FFFF;color:#25A1A1">Description</div>
{| class="wikitable"
<dl style="width:100%;">
|<span style="border:5px double black">!Description:</span>|
<dt style="min-width:100%;clear:both;font-weight:bold;position:absolute;padding:.3em;">Description:</dt>
|This function initializes kosherArsenal itself, it must be run locally (eg. from initPlayerLocal.sqf), it is blocking meaning it won't execute any code placed after the function call until the initial spawn arsenal has been exited.
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
|-
This function initializes kosherArsenal itself, it must be run locally (eg. from initPlayerLocal.sqf), it is blocking meaning it won't execute any code placed after the function call until the initial spawn arsenal has been exited.
!Execution:
</div></dd>
|call
 
|-
<dt style="min-width:100%;clear:both;font-weight:bold;position:absolute;padding:.3em;">Execution:</dt>
!Groups:
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
|Utility Functions: Eric's Mission Framework
call
|}
</div></dd>
===Syntax===
 
{| class="wikitable"
<dt style="min-width:100%;clear:both;font-weight:bold;position:absolute;padding:.3em;">GroupsGroups:</dt>
!Syntax:
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
|[Light, ForcePrimary] call '''EMF_fnc_kosherArsenal'''
Utility Functions: Eric's Mission Framework
|-
</div></dd>
!Parameters:
</dl>
|Light: Boolean - (Optional) When true creates a light source at the arsenal to help with visibility. [Default: false]
 
<div style="padding:0.33em 2em;font-size:1.2em;font-weight:bold;display:block;border-bottom: #25A1A1 solid 1px; background-color:#E0FFFF;color:#25A1A1">Syntax</div>
<dl style="width:100%;">
<dt style="min-width:100%;clear:both;font-weight:bold;position:absolute;padding:.3em;">Syntax:</dt>
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
[Light, ForcePrimary] call '''EMF_fnc_kosherArsenal'''
</div></dd>
 
<dt style="min-width:100%;clear:both;font-weight:bold;position:absolute;padding:.3em;">Parameters:</dt>
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
Light: Boolean - (Optional) When true creates a light source at the arsenal to help with visibility. [Default: false]
</div></dd>
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
ForcePrimary: Boolean - (Optional) When true will not allow player to exit arsenal unless a primary firearm has been equipped. [Default: true]
ForcePrimary: Boolean - (Optional) When true will not allow player to exit arsenal unless a primary firearm has been equipped. [Default: true]
|-
</div></dd>
!Return Value:
|Boolean - Returns true on success.
|}


===Examples===
<dt style="min-width:100%;clear:both;font-weight:bold;position:absolute;padding:.3em;">Return Value:</dt>
// Initializes Kosher Arsenal with light off and forced primary
<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
[false, true] call '''EMF_fnc_kosherArsenal''';
Boolean - Returns true on success.
</div></dd>
</dl>


  // Initializes Kosher Arsenal with light on
<div style="padding:0.33em 2em;font-size:1.2em;font-weight:bold;display:block; border-bottom: #25A1A1 solid 1px; background-color:#E0FFFF;color:#25A1A1">Examples</div>
<dl style="width:100%;">
<dt style="min-width:100%;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;">
// Initializes Kosher Arsenal with light off and forced primary<br>
[false, true] call EMF_fnc_kosherArsenal;
</code></dd>
 
<dt style="min-width:100%;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;">
  // Initializes Kosher Arsenal with light on<br>
  [true] call '''EMF_fnc_kosherArsenal''';
  [true] call '''EMF_fnc_kosherArsenal''';
</code></dd>


  // Loads a loadout and initializes with light off
<dt style="min-width:100%;clear:both;font-weight:bold;position:absolute;padding:.3em;">Example 3:</dt>
  <nowiki>[["GERMANY_MID90_ARMY_WDL"]]</nowiki> call '''EMF_fnc_kosherArsenalLoad''';
<dd style="width:90%;padding:.3em .3em .3em 7em;"><code style="border:#25A1A1 dashed 1px;display:block;">
  // Loads a loadout and initializes with light off<br>
  <nowiki>[["GERMANY_MID90_ARMY_WDL"]]</nowiki> call '''EMF_fnc_kosherArsenalLoad''';<br>
  [false] call '''EMF_fnc_kosherArsenal''';
  [false] call '''EMF_fnc_kosherArsenal''';
</code></dd>
</dl>


 
<div style="padding:0.33em 2em;font-size:1.2em;font-weight:bold;display:block;border-bottom: #25A1A1 solid 1px; background-color:#E0FFFF;color:#25A1A1">Notes</div>
===Notes===
[[Category:Kosher Arsenal: Eric's Mission Framework]]
[[Category:Kosher Arsenal: Eric's Mission Framework]]

Revision as of 18:20, 15 June 2021

Description
Description:

This function initializes kosherArsenal itself, it must be run locally (eg. from initPlayerLocal.sqf), it is blocking meaning it won't execute any code placed after the function call until the initial spawn arsenal has been exited.

Execution:

call

GroupsGroups:

Utility Functions: Eric's Mission Framework

Syntax
Syntax:

[Light, ForcePrimary] call EMF_fnc_kosherArsenal

Parameters:

Light: Boolean - (Optional) When true creates a light source at the arsenal to help with visibility. [Default: false]

ForcePrimary: Boolean - (Optional) When true will not allow player to exit arsenal unless a primary firearm has been equipped. [Default: true]

Return Value:

Boolean - Returns true on success.

Examples
Example 1:
// Initializes Kosher Arsenal with light off and forced primary
[false, true] call EMF_fnc_kosherArsenal;
Example 2:
// Initializes Kosher Arsenal with light on
[true] call EMF_fnc_kosherArsenal;
Example 3:
// Loads a loadout and initializes with light off
[["GERMANY_MID90_ARMY_WDL"]] call EMF_fnc_kosherArsenalLoad;
[false] call EMF_fnc_kosherArsenal;
Notes
Retrieved from "https://wiki.cluster-community.com/index.php?title=Init_(Kosher_Arsenal)&oldid=37"