Difference between revisions of "createSimpleObject"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Update version for local variant)
m
 
(49 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
|arma3|= Game name
 
|1.58|= Game version
 
|eff= global|= Effects in MP
 
  
| Create object with given shape defined as path to .p3d model. Supported [[LOD]]s include [[LOD#Geometry|Geometry]], [[LOD#Fire_Geometry|Fire Geometry]], [[LOD#Roadway|Roadway]], [[LOD#ViewGeometry|View Geometry]] and [[LOD#ShadowVolume|ShadowVolume]]. Supported features include collision, texturing, animation, penetration, AI spotting occlusion, and surface specific sounds (like footsteps). Unsupported features include PhysX, damage, AI pathfinding (causes walking through walls), and built in lights.<br><br>
+
|game1= arma3
 +
|version1= 1.58
  
Given the simulation limitations, global decorative objects can be created with very little network traffic. Objects that could be exclusively created with this command are: trees, bushes, rocks, bridges, roads, vehicle wrecks, custom models in mission, and other objects without a class in config. The height of the placement position might need to be adjusted experimentally. Some of the model examples could be found here: [[createSimpleObject/objects]]<br><br>
+
|eff= global
  
Guide: [[Arma 3 Simple Objects]]<br><br>
+
|gr1= Object Manipulation
  
{{Informative|One '''cannot''' attach actions to a simple object via [[addAction]].}}
+
|descr= Create object with given shape defined as path to .p3d model. Supported [[LOD]]s include [[LOD#Geometry|Geometry]], [[LOD#Fire_Geometry|Fire Geometry]], [[LOD#Roadway|Roadway]], [[LOD#ViewGeometry|View Geometry]] and [[LOD#ShadowVolume|ShadowVolume]]. Supported features include collision, texturing, animation, penetration, AI spotting occlusion, and surface specific sounds (like footsteps). Unsupported features include PhysX, damage, AI pathfinding (causes walking through walls), and built in lights.<br><br>
  
'''NOTES''':  
+
Given the simulation limitations, global decorative objects can be created with very little network traffic. Objects that could be exclusively created with this command are: trees, bushes, rocks, bridges, roads, vehicle wrecks, custom models in mission, and other objects without a class in config. The height of the placement position might need to be adjusted experimentally.<br>
 +
Some of the models can be found here: [[createSimpleObject/objects]].<br>
 +
For Livonia furniture see: [[Arma 3 Livonia Props]].<br><br>
 +
 
 +
See [[Arma 3: Simple Objects]] to learn more about simple objects.
 +
 
 +
{{Feature | Informative |
 +
* [[addAction]] does not work with simple objects.
 
* Objects created with Syntax 1 cannot be textured. Some objects may also have inverted default direction.  
 
* Objects created with Syntax 1 cannot be textured. Some objects may also have inverted default direction.  
 
* Objects created with Syntax 2 can be textured. The default direction should match the direction of the object if it was created with [[createVehicle]].
 
* Objects created with Syntax 2 can be textured. The default direction should match the direction of the object if it was created with [[createVehicle]].
 +
* Only as of {{GVI|arma3|1.67}} do simple objects support [[getVariable]] and [[setVariable]].
 +
}}
 +
{{Feature | Important | The path to the .p3d model must '''not''' start with a backslash:
 +
{{{!}}
 +
{{!}} {{Icon|unchecked}} {{!}}{{!}} <tt>"'''\'''a3\armor_f_beta...</tt>
 +
{{!}}-
 +
{{!}} {{Icon|checked}} {{!}}{{!}} <tt>"a3\armor_f_beta...</tt>
 +
{{!}}}
 +
}}
  
Since Arma 3 v1.67 simple objects support [[setVariable]] and [[getVariable]]. Since Arma 3 v1.95.145741 it is possible to create local object instances, similar to [[createVehicleLocal]]
+
|s1= [[createSimpleObject]] [shapeName, positionWorld, local]
|DESCRIPTION=
 
  
| '''createSimpleObject''' [shapeName, positionWorld, local] |SYNTAX=
+
|p1= shapeName: [[String]] - Path to the 3d model (can be obtained with [[getModelInfo]] command)
|p1= [shapeName, positionWorld, local]: [[Array]]|=
 
|p2= shapeName: [[String]] - Path to the 3d model (can be obtained with [[getModelInfo]] command) |PARAMETER1=
 
|p3= positionWorld: [[Array]] - placement position in format [[PositionWorld]] |PARAMETER2=
 
|p4= local (Optional): [[Boolean]] - [[true]] to create local instance only. Default: [[false]] (since Arma 3 v1.94.145903)|PARAMETER3=
 
| [[Object]] - Created simple object |RETURNVALUE=
 
  
|s2= '''createSimpleObject''' [className, positionASL, local] |SYNTAX=
+
|p2= positionWorld: [[PositionWorld]] - Placement position
|p21= [className, positionASL, local] : [[Array]]|=
+
 
|p22= className: [[String]] - [[CfgVehicles]] config class name|PARAMETER1=
+
|p3= local (Optional, default [[false]]): [[Boolean]] - [[true]] to create a local instance only
|p23= positionASL: [[Array]] - placement position in format [[PositionASL]] |PARAMETER2=
+
|p3since= arma3 1.96
|p24= local (Optional): [[Boolean]] - [[true]] to create local instance only. Default: [[false]] (since Arma 3 v1.95.145741) |PARAMETER3=
+
 
|r2= [[Object]] - Created simple object |RETURNVALUE=
+
|r1= [[Object]] - Created simple object
 +
 
 +
|s2= [[createSimpleObject]] [className, positionASL, local]
 +
 
 +
|p21= className: [[String]] - [[CfgVehicles]] class name
 +
 
 +
|p22= positionASL: [[PositionASL]] - Placement position
 +
 
 +
|p23= local (Optional, default [[false]]): [[Boolean]] - [[true]] to create a local instance only
 +
|p23since= arma3 1.96
 +
 
 +
|r2= [[Object]] - Created simple object
  
 
|x1= <code>_pos = [[player]] [[getRelPos]] [10, 0];
 
|x1= <code>_pos = [[player]] [[getRelPos]] [10, 0];
Line 42: Line 61:
 
   
 
   
 
_tank [[animate]] ["Wheel_podkoloL3", 0.5, [[true]]];
 
_tank [[animate]] ["Wheel_podkoloL3", 0.5, [[true]]];
_tank [[animate]] ["Wheel_podkoloL6", 0.5, [[true]]];</code>|EXAMPLE1=
+
_tank [[animate]] ["Wheel_podkoloL6", 0.5, [[true]]];</code>
  
|x2= <code>_pos = [[player]] [[getRelPos]] [10, 0];  
+
|x2= <code>_pos = [[player]] [[getRelPos]] [10, 0];
_tank = [[createSimpleObject]] ["B_APC_Tracked_01_CRV_F", [[AGLtoASL]] _pos];  
+
_tank = [[createSimpleObject]] ["B_APC_Tracked_01_CRV_F", [[AGLtoASL]] _pos];
_tank [[setObjectTexture]] [0, "#(rgb,8,8,3)color(0,1,0,0.01)"];  
+
_tank [[setObjectTexture]] [0, "#(rgb,8,8,3)color(0,1,0,0.01)"];
  
_tank [[hideSelection]] ["zasleh", [[true]]];  
+
_tank [[hideSelection]] ["zasleh", [[true]]];
_tank [[hideSelection]] ["zasleh2", [[true]]];  
+
_tank [[hideSelection]] ["zasleh2", [[true]]];
_tank [[hideSelection]] ["clan", [[true]]];  
+
_tank [[hideSelection]] ["clan", [[true]]];
 
    
 
    
_tank [[animate]] ["Wheel_podkoloL3", 0.5, [[true]]];  
+
_tank [[animate]] ["Wheel_podkoloL3", 0.5, [[true]]];
_tank [[animate]] ["Wheel_podkoloL6", 0.5, [[true]]];</code>|EXAMPLE2=
+
_tank [[animate]] ["Wheel_podkoloL6", 0.5, [[true]]];</code>
  
| [[isSimpleObject]], [[hideSelection]], [[selectionPosition]], [[getModelInfo]], [[getObjectType]], [[cursorObject]], [[selectionNames]], [[animationNames]], [[createVehicle]], [[enableSimulation]], [[hideObject]], [[Arma_3_Simple_Objects|Simple Objects Guide]] |SEEALSO=
+
|seealso= [[isSimpleObject]] [[hideSelection]] [[selectionPosition]] [[getModelInfo]] [[getObjectType]] [[cursorObject]] [[selectionNames]] [[animationNames]] [[createVehicle]] [[enableSimulation]] [[hideObject]] [[getMissionPath]] [[allLODs]] [[Arma 3: Simple Objects]]
|  |MPBEHAVIOUR=
 
 
}}
 
}}
  
<h3 style='display:none'>Bottom Section</h3>
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
 
 
<h3 style='display:none'>Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
<!-- BEGIN Note Section -->
 
<!-- END Note Section -->
 
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
<dt></dt>
 
 
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
 
<dd class="notedate">Posted on April 18, 2016 - 20:03 (UTC)</dd>
 
<dd class="notedate">Posted on April 18, 2016 - 20:03 (UTC)</dd>
 
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
Line 79: Line 85:
 
<code>_heli = "B_Heli_Light_01_F" [[createVehicleLocal]] ([[player]] [[getRelPos]] [10, 0]);
 
<code>_heli = "B_Heli_Light_01_F" [[createVehicleLocal]] ([[player]] [[getRelPos]] [10, 0]);
 
_position = [[getPosWorld]] _heli;
 
_position = [[getPosWorld]] _heli;
_vectorDirUp = <nowiki>[</nowiki>[[vectorDir]] _heli, [[vectorUp]] _heli];
+
_vectorDirUp = [<nowiki/>[[vectorDir]] _heli, [[vectorUp]] _heli];
 
_model = [[getModelInfo]] _heli [[select]] 1;
 
_model = [[getModelInfo]] _heli [[select]] 1;
 
[[deleteVehicle]] _heli;
 
[[deleteVehicle]] _heli;
Line 85: Line 91:
 
_simpleHeli [[setVectorDirAndUp]] _vectorDirUp;</code>
 
_simpleHeli [[setVectorDirAndUp]] _vectorDirUp;</code>
 
</dd>
 
</dd>
</dl>
 
<!-- DISCONTINUE Notes -->
 
  
<!-- CONTINUE Notes -->
+
<dt><dt>
<dl class="command_description">
 
 
<dd class="notedate">Posted on April 28, 2016 - 18:10 (UTC)</dd>
 
<dd class="notedate">Posted on April 28, 2016 - 18:10 (UTC)</dd>
 
<dt class="note">[[User:Waffle SS.|Waffle SS.]]</dt>
 
<dt class="note">[[User:Waffle SS.|Waffle SS.]]</dt>
 
<dd class="note">
 
<dd class="note">
Models from within the mission file/folder can be created, but full system path is needed. Use:
+
Models from within the mission file/folder can be created, but full system path is needed. Use: [[getMissionPath]]
<code>([[str]] [[missionConfigFile]] [[select]] [0, [[count]] [[str]] [[missionConfigFile]] - 15]) + "myModel.p3d"
 
//mission folder path code from: http://killzonekid.com/arma-scripting-tutorials-mission-root/</code>
 
 
</dd>
 
</dd>
</dl>
 
<!-- DISCONTINUE Notes -->
 
  
<!-- CONTINUE Notes -->
+
<dt><dt>
<dl class="command_description">
 
 
<dd class="notedate">Posted on May 11, 2016 - 01:28 (UTC)</dd>
 
<dd class="notedate">Posted on May 11, 2016 - 01:28 (UTC)</dd>
 
<dt class="note">[[User:Waffle SS.|Waffle SS.]]</dt>
 
<dt class="note">[[User:Waffle SS.|Waffle SS.]]</dt>
Line 107: Line 105:
 
[[simulationEnabled]] returns false.
 
[[simulationEnabled]] returns false.
 
</dd>
 
</dd>
</dl>
 
<!-- DISCONTINUE Notes -->
 
  
<!-- CONTINUE Notes -->
+
<dt><dt>
<dl class="command_description">
 
 
<dd class="notedate">Posted on September 5, 2016 - 15:10 (UTC)</dd>
 
<dd class="notedate">Posted on September 5, 2016 - 15:10 (UTC)</dd>
 
<dt class="note">[[User:Warka|Warka]]</dt>
 
<dt class="note">[[User:Warka|Warka]]</dt>
Line 130: Line 125:
 
* [[BIS_fnc_adjustSimpleObject]]
 
* [[BIS_fnc_adjustSimpleObject]]
 
** adjusts simple object to looks as close to the non-simple object as possible
 
** adjusts simple object to looks as close to the non-simple object as possible
** function is internally called from the 'bis_fnc_createSimpleObject', you won't probably need to call this function directly
+
** function is internally called from the 'BIS_fnc_createSimpleObject', you won't probably need to call this function directly
  
 
Check the function headers for more info about the input parameters and possibilities.
 
Check the function headers for more info about the input parameters and possibilities.
 
</dd>
 
</dd>
 +
 
</dl>
 
</dl>
<!-- DISCONTINUE Notes -->
 

Latest revision as of 14:21, 9 October 2021

Hover & click on the images for description

Description

Description:
Create object with given shape defined as path to .p3d model. Supported LODs include Geometry, Fire Geometry, Roadway, View Geometry and ShadowVolume. Supported features include collision, texturing, animation, penetration, AI spotting occlusion, and surface specific sounds (like footsteps). Unsupported features include PhysX, damage, AI pathfinding (causes walking through walls), and built in lights.

Given the simulation limitations, global decorative objects can be created with very little network traffic. Objects that could be exclusively created with this command are: trees, bushes, rocks, bridges, roads, vehicle wrecks, custom models in mission, and other objects without a class in config. The height of the placement position might need to be adjusted experimentally.
Some of the models can be found here: createSimpleObject/objects.
For Livonia furniture see: Arma 3 Livonia Props.

See Arma 3: Simple Objects to learn more about simple objects.
  • addAction does not work with simple objects.
  • Objects created with Syntax 1 cannot be textured. Some objects may also have inverted default direction.
  • Objects created with Syntax 2 can be textured. The default direction should match the direction of the object if it was created with createVehicle.
  • Only as of Arma 3 logo black.png1.67 do simple objects support getVariable and setVariable.
The path to the .p3d model must not start with a backslash:
Ico none.png "\a3\armor_f_beta...
Ico ok.png "a3\armor_f_beta...
Groups:
Object Manipulation

Syntax

Syntax:
createSimpleObject [shapeName, positionWorld, local]
Parameters:
shapeName: String - Path to the 3d model (can be obtained with getModelInfo command)
positionWorld: PositionWorld - Placement position
since 25.2px1.96
local (Optional, default false): Boolean - true to create a local instance only
Return Value:
Object - Created simple object

Alternative Syntax

Syntax:
createSimpleObject [className, positionASL, local]
Parameters:
className: String - CfgVehicles class name
positionASL: PositionASL - Placement position
since 25.2px1.96
local (Optional, default false): Boolean - true to create a local instance only
Return Value:
Object - Created simple object

Examples

Example 1:
_pos = player getRelPos [10, 0]; _tank = createSimpleObject ["a3\armor_f_beta\apc_tracked_01\apc_tracked_01_rcws_f.p3d", _pos]; _tank setPos (_pos vectorAdd (getPosWorld _tank vectorDiff (_tank modelToWorld [0,0,0]))); _tank hideSelection ["zasleh", true]; _tank hideSelection ["zasleh2", true]; _tank hideSelection ["clan", true]; _tank animate ["Wheel_podkoloL3", 0.5, true]; _tank animate ["Wheel_podkoloL6", 0.5, true];
Example 2:
_pos = player getRelPos [10, 0]; _tank = createSimpleObject ["B_APC_Tracked_01_CRV_F", AGLtoASL _pos]; _tank setObjectTexture [0, "#(rgb,8,8,3)color(0,1,0,0.01)"]; _tank hideSelection ["zasleh", true]; _tank hideSelection ["zasleh2", true]; _tank hideSelection ["clan", true]; _tank animate ["Wheel_podkoloL3", 0.5, true]; _tank animate ["Wheel_podkoloL6", 0.5, true];

Additional Information

See also:
isSimpleObject hideSelection selectionPosition getModelInfo getObjectType cursorObject selectionNames animationNames createVehicle enableSimulation hideObject getMissionPath allLODs Arma 3: Simple Objects

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
Posted on April 18, 2016 - 20:03 (UTC)
Killzone Kid
The easiest way to correctly place simple object is to create normal object of the same shape from class (if possible), then copy getPosWorld, vectorDir and vectorUp from it. Then create the simple object and apply copied values to it, this will position simple object exactly as normal object was positioned: _heli = "B_Heli_Light_01_F" createVehicleLocal (player getRelPos [10, 0]); _position = getPosWorld _heli; _vectorDirUp = [vectorDir _heli, vectorUp _heli]; _model = getModelInfo _heli select 1; deleteVehicle _heli; _simpleHeli = createSimpleObject [_model, _position]; _simpleHeli setVectorDirAndUp _vectorDirUp;
Posted on April 28, 2016 - 18:10 (UTC)
Waffle SS.
Models from within the mission file/folder can be created, but full system path is needed. Use: getMissionPath
Posted on May 11, 2016 - 01:28 (UTC)
Waffle SS.
simulationEnabled returns false.
Posted on September 5, 2016 - 15:10 (UTC)
Warka
There is a section in function library dedicated to simple object creation and interaction. It's purpose is to simplify the operations:
  • BIS_fnc_createSimpleObject
    • creates simple object according to the supplied data
    • you can supply p3d path, class name or data you get from scanning a non-simple object
  • BIS_fnc_simpleObjectData
    • gathers and returns data about the non-simple object
    • data can be then used to create simple object
  • BIS_fnc_replaceWithSimpleObject
    • replaces non-simple object with simple object on the scene
    • do not use it in large scale in MP missions as it is not network efficient
  • BIS_fnc_adjustSimpleObject
    • adjusts simple object to looks as close to the non-simple object as possible
    • function is internally called from the 'BIS_fnc_createSimpleObject', you won't probably need to call this function directly
Check the function headers for more info about the input parameters and possibilities.