BIS fnc FTLmanager: Difference between revisions

From Bohemia Interactive Community
m (1 revision)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *O([a-z ])" to "$1 - o$2")
 
(36 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2oa
____________________________________________________________________________________________
|version1= 1.50


| arma2oa |= Game name
|game2= tkoh
|version2= 1.00


|1.00|= Game version
|game3= arma3
____________________________________________________________________________________________
|version3= 0.50


| ''N/A'' |= Description
|gr1= Sides
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_FTLmanager]]; --> |= Syntax
|descr= '''FTL''' ('''F'''riendly '''T'''o '''L'''ocal) manager tracks relationship between player and civilian side.<br>
'''FTL State''' can be one of the following: "LOW", "NEUTRAL", "HIGH". See [[FriendlyToLocal System]].


|p1= |= Parameter 1
|s1= [functionCalled, type] call [[BIS_fnc_FTLmanager]]


| |= Return value
|p1= functionCalled: [[String]] - one of the following:
____________________________________________________________________________________________
* "Init" - initialises the FTL manager<br>Return: [[Number]] - FTL State
* "Destroy" - destroys the current FTL manager instance<br>Return:
* "GetFTLState" - returns current FTL state<br>Return: [[String]] - FTL state: "LOW", "NEUTRAL" or "HIGH"
* "SetFTLState" - computes and sets the new FTLValue and FTLState afterwards<br>Return:
* "GetNearestTownRespect" - Returns nearest (in 500m radius) town respect for player<br>Return: [[Number]] - respect


|x1= <code></code> |=  
|p2= type: [[String]] - can be one of the following:
____________________________________________________________________________________________
* "sysUpdate" (internal use)
* "NONE" (no change)
* "CivKilled" (-0.5)
* "VIPCivKilled" (-0.7)
* "RebelKilled" (-0.3)
* "TaskSmallRefused" (-0.05)
* "TaskSmallDone" (+0.4)
* "TaskSmallFailed" (-0.4)
* "TaskGreatRefused" (-0.1)
* "TaskGreatDone" (+0.6)
* "TaskGreatFailed" (-0.6)
* "CivHouseDestroyed" (-0.5)
* "GreatHouseDestroyed" (-0.8)


| |= See also
|r1= [[Boolean]] - [[false]] if the manager is not initialised yet


|x1= <sqf>["Init"] call BIS_fnc_FTLmanager;</sqf>
|seealso= [[FriendlyToLocal System]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Systems|{{uc:FTLmanager}}]]
[[Category:Functions|{{uc:FTLmanager}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:FTLmanager}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:FTLmanager}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:FTLmanager}}]]

Latest revision as of 15:44, 8 November 2023

A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
Hover & click on the images for description

Description

Description:
FTL (Friendly To Local) manager tracks relationship between player and civilian side.
FTL State can be one of the following: "LOW", "NEUTRAL", "HIGH". See FriendlyToLocal System.
Execution:
call
Groups:
Sides

Syntax

Syntax:
[functionCalled, type] call BIS_fnc_FTLmanager
Parameters:
functionCalled: String - one of the following:
  • "Init" - initialises the FTL manager
    Return: Number - FTL State
  • "Destroy" - destroys the current FTL manager instance
    Return:
  • "GetFTLState" - returns current FTL state
    Return: String - FTL state: "LOW", "NEUTRAL" or "HIGH"
  • "SetFTLState" - computes and sets the new FTLValue and FTLState afterwards
    Return:
  • "GetNearestTownRespect" - Returns nearest (in 500m radius) town respect for player
    Return: Number - respect
type: String - can be one of the following:
  • "sysUpdate" (internal use)
  • "NONE" (no change)
  • "CivKilled" (-0.5)
  • "VIPCivKilled" (-0.7)
  • "RebelKilled" (-0.3)
  • "TaskSmallRefused" (-0.05)
  • "TaskSmallDone" (+0.4)
  • "TaskSmallFailed" (-0.4)
  • "TaskGreatRefused" (-0.1)
  • "TaskGreatDone" (+0.6)
  • "TaskGreatFailed" (-0.6)
  • "CivHouseDestroyed" (-0.5)
  • "GreatHouseDestroyed" (-0.8)
Return Value:
Boolean - false if the manager is not initialised yet

Examples

Example 1:
["Init"] call BIS_fnc_FTLmanager;

Additional Information

See also:
FriendlyToLocal System

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_FTLmanager&oldid=348927"