{"name":"BIS_fnc_diagMacrosSimpleObject","operator":null,"title":"BIS fnc diagMacrosSimpleObject","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_diagMacrosSimpleObject","revid":286045,"updated":"2021-06-20T17:24:45Z","groups":["Diagnostic"],"status":"ok","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.00"}],"since":{"game":"arma3","name":"Arma 3","version":"1.00"},"arma3_since":"1.00","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"description":"Generates simple object config data.","syntaxes":[{"syntax":"[] call BIS_fnc_diagMacrosSimpleObject","since":null,"effect":null,"exec":null,"params":[{"name":"param0","type":"Object, Array","types":["Object","Array"],"optional":false,"default":"position calculated 15 meters away from player","description":"ground position where ground objects will be created (default: position calculated 15 meters away from player)","since":null,"text":"0: OBJECT or ARRAY - ground position where ground objects will be created (default: position calculated 15 meters away from player)","source":"docblock"},{"name":"param1","type":"Number, Boolean","types":["Number","Boolean"],"optional":false,"default":"false","description":"autolog mode (default: false)\n0 or false - no autolog, results will be only stored in clipboard\n1 or true - autolog on, results will be stored in \\A3\\macros_CfgVehicles_simpleObject_auto_A3.hpp file.\n2 - autlog on + world name, random number and custom suffix are appended to name of generated file to prevent overwriting and provide extra info","since":null,"text":"1: SCALAR or BOOL - autolog mode (default: false)\n0 or false - no autolog, results will be only stored in clipboard\n1 or true - autolog on, results will be stored in \\A3\\macros_CfgVehicles_simpleObject_auto_A3.hpp file.\n2 - autlog on + world name, random number and custom suffix are appended to name of generated file to prevent overwriting and provide extra info","source":"docblock"},{"name":"param2","type":"Array","types":["Array"],"optional":false,"default":"[]","description":"classes you want to scan, use [] to scan all (default: []).","since":null,"text":"2: ARRAY - classes you want to scan, use [] to scan all (default: []).","source":"docblock"},{"name":"param3","type":"Object, Array","types":["Object","Array"],"optional":false,"default":"position calculated 15 meters away from player","description":"sea position where ground objects will be created (default: position calculated 15 meters away from player)","since":null,"text":"3: OBJECT or ARRAY - sea position where ground objects will be created (default: position calculated 15 meters away from player)","source":"docblock"},{"name":"param4","type":"String","types":["String"],"optional":false,"default":"\"\"","description":"custom suffix added to filename if autolog is used (default: \"\").","since":null,"text":"4: STRING - custom suffix added to filename if autolog is used (default: \"\").","source":"docblock"}],"returns":{"type":"","types":[],"description":null,"text":""}}],"examples":[{"text":"```sqf\nbis_scriptHandle = [] spawn BIS_fnc_diagMacrosSimpleObject;\n```","code":["bis_scriptHandle = [] spawn BIS_fnc_diagMacrosSimpleObject;"]},{"text":"```sqf\nExpected output per class (animate and hide arrays can have varying amount of elements):\n#define CFGVEHICLES_SIMPLEOBJECT_class_F\\\n    class SimpleObject\\\n    {\\\n        animate[] =\\\n        {\\\n            {\"animationName1\", 1},\\\n            {\"animationName2\", 2}\\\n        };\\\n        hide[] =\\\n        {\\\n            \"animationSelection1\",\\\n            \"animationSelection2\"\\\n        };\\\n        verticalOffsetAsl = 0;\\\n    };\n```","code":["Expected output per class (animate and hide arrays can have varying amount of elements):\n#define CFGVEHICLES_SIMPLEOBJECT_class_F\\\n    class SimpleObject\\\n    {\\\n        animate[] =\\\n        {\\\n            {\"animationName1\", 1},\\\n            {\"animationName2\", 2}\\\n        };\\\n        hide[] =\\\n        {\\\n            \"animationSelection1\",\\\n            \"animationSelection2\"\\\n        };\\\n        verticalOffsetAsl = 0;\\\n    };"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":[],"notes":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: Diagnostic","Functions","Introduced with Arma 3 version 1.00"],"docblock":{"author":null,"description":"Generates simple object config data.","params":[{"index":0,"name":null,"types":["Object","Array"],"optional":false,"default":"position calculated 15 meters away from player","description":"ground position where ground objects will be created (default: position calculated 15 meters away from player)","text":"OBJECT or ARRAY - ground position where ground objects will be created (default: position calculated 15 meters away from player)"},{"index":1,"name":null,"types":["Number","Boolean"],"optional":false,"default":"false","description":"autolog mode (default: false)\n0 or false - no autolog, results will be only stored in clipboard\n1 or true - autolog on, results will be stored in \\A3\\macros_CfgVehicles_simpleObject_auto_A3.hpp file.\n2 - autlog on + world name, random number and custom suffix are appended to name of generated file to prevent overwriting and provide extra info","text":"SCALAR or BOOL - autolog mode (default: false)\n0 or false - no autolog, results will be only stored in clipboard\n1 or true - autolog on, results will be stored in \\A3\\macros_CfgVehicles_simpleObject_auto_A3.hpp file.\n2 - autlog on + world name, random number and custom suffix are appended to name of generated file to prevent overwriting and provide extra info"},{"index":2,"name":null,"types":["Array"],"optional":false,"default":"[]","description":"classes you want to scan, use [] to scan all (default: []).","text":"ARRAY - classes you want to scan, use [] to scan all (default: [])."},{"index":3,"name":null,"types":["Object","Array"],"optional":false,"default":"position calculated 15 meters away from player","description":"sea position where ground objects will be created (default: position calculated 15 meters away from player)","text":"OBJECT or ARRAY - sea position where ground objects will be created (default: position calculated 15 meters away from player)"},{"index":4,"name":null,"types":["String"],"optional":false,"default":"\"\"","description":"custom suffix added to filename if autolog is used (default: \"\").","text":"STRING - custom suffix added to filename if autolog is used (default: \"\")."}],"returns":null,"examples":["bis_scriptHandle = [] spawn BIS_fnc_diagMacrosSimpleObject;","Expected output per class (animate and hide arrays can have varying amount of elements):\n#define CFGVEHICLES_SIMPLEOBJECT_class_F\\\n    class SimpleObject\\\n    {\\\n        animate[] =\\\n        {\\\n            {\"animationName1\", 1},\\\n            {\"animationName2\", 2}\\\n        };\\\n        hide[] =\\\n        {\\\n            \"animationSelection1\",\\\n            \"animationSelection2\"\\\n        };\\\n        verticalOffsetAsl = 0;\\\n    };"],"syntax":null,"execution":null,"notes":null,"requirements":null,"meta":{},"text":"Generates simple object config data.\n\nParameters:\n    0: OBJECT or ARRAY - ground position where ground objects will be created (default: position calculated 15 meters away from player)\n    1: SCALAR or BOOL - autolog mode (default: false)\n        0 or false - no autolog, results will be only stored in clipboard\n        1 or true - autolog on, results will be stored in \\A3\\macros_CfgVehicles_simpleObject_auto_A3.hpp file.\n        2 - autlog on + world name, random number and custom suffix are appended to name of generated file to prevent overwriting and provide extra info\n    2: ARRAY - classes you want to scan, use [] to scan all (default: []).\n    3: OBJECT or ARRAY - sea position where ground objects will be created (default: position calculated 15 meters away from player)\n    4: STRING - custom suffix added to filename if autolog is used (default: \"\").\n\nExample:\nbis_scriptHandle = [] spawn BIS_fnc_diagMacrosSimpleObject;\n\nExpected output per class (animate and hide arrays can have varying amount of elements):\n#define CFGVEHICLES_SIMPLEOBJECT_class_F\\\n    class SimpleObject\\\n    {\\\n        animate[] =\\\n        {\\\n            {\"animationName1\", 1},\\\n            {\"animationName2\", 2}\\\n        };\\\n        hide[] =\\\n        {\\\n            \"animationSelection1\",\\\n            \"animationSelection2\"\\\n        };\\\n        verticalOffsetAsl = 0;\\\n    };"},"filled_from_docblock":["description","params","examples"]}