Difference between revisions of "cmf 3den fnc unitConstructor"

From cluster wiki
Jump to navigation Jump to search
Line 21: Line 21:
* Group Name: [https://community.bistudio.com/wiki/String String] - The group name as displayed ingame
* Group Name: [https://community.bistudio.com/wiki/String String] - The group name as displayed ingame
* Lobby Group Name: [https://community.bistudio.com/wiki/String String] - The group name as displayed in the lobby
* Lobby Group Name: [https://community.bistudio.com/wiki/String String] - The group name as displayed in the lobby
* Group Type: [https://community.bistudio.com/wiki/String String] - The group type, must be a value defined in CMF_ORBAT in the [[Category:CMF3: Config|CMF3 Config]]
* Group Type: [https://community.bistudio.com/wiki/String String] - The group type, must be a value defined in CMF_ORBAT in the [[:Category:CMF3: Config|CMF3 Config]]
* Group Size: [https://community.bistudio.com/wiki/String String] - The group size, must be a value defined in CMF_ORBAT in the [[Category:CMF3: Config|CMF3 Config]]
* Group Size: [https://community.bistudio.com/wiki/String String] - The group size, must be a value defined in CMF_ORBAT in the [[:Category:CMF3: Config|CMF3 Config]]
* Group Position Offset: [https://community.bistudio.com/wiki/Number Number] - The positional offset of the group from the center of the camera
* Group Position Offset: [https://community.bistudio.com/wiki/Number Number] - The positional offset of the group from the center of the camera
* Group Units Array:
* Group Units Array:

Revision as of 17:32, 17 December 2022


Hover & click on the images for description
Description
Description:
This function is mostly a lookup table for Cluster ORBAT structured units. If you are looking to modify the ORBAT this is the file to edit.
This is an internal function. This means that the function is called by another function and should not be called manually.
Execution:
Call
Groups:
CMF3: 3den
Syntax
Syntax:
[unitIdentifier] call cmf_3den_fnc_unitConstructor
Parameters:
unitIdentifier: String - The unit to lookup
Return Value:
Unit Array:
  • Group Name: String - The group name as displayed ingame
  • Lobby Group Name: String - The group name as displayed in the lobby
  • Group Type: String - The group type, must be a value defined in CMF_ORBAT in the CMF3 Config
  • Group Size: String - The group size, must be a value defined in CMF_ORBAT in the CMF3 Config
  • Group Position Offset: Number - The positional offset of the group from the center of the camera
  • Group Units Array:
    • Unit Array:
      • Unit classname: String - The classname of the unit to spawn
      • Unit Name: String - The name to display in the lobby
      • Unit Role: String - The unit's CMF Role
      • Unit leader: Boolean - The unit's leadership status in the group (if true unit will be group leader)
      • Unit X position offset: Number - The X positional offset of the group from the center of the camera
      • Unit Y position offset: Number - The Y positional offset of the group from the center of the camera
Examples
Example 1:
["SQUAD"] call cmf_3den_fnc_unitConstructor;
Additional Information
See also:
See also needed
Internal Variables
No internal variables
Events
No events
Notes