elevatePeriscope: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page creation, waiting for KK)
 
No edit summary
Line 6: Line 6:
____________________________________________________________________________________________
____________________________________________________________________________________________


|descr= TBD. {{wip}} |Description=
|descr= Elevates periscope of a vehicle. Vehicles in Arma 3 which are compatible with this tech are Strider, remote laser designators, the robot arm on Eddie, etc. Please note that SDV submarine has a different periscope, which is just an animated selection and could be raised and lowered with [[animate]] command.
{{Informative | User can immediately override any elevation in progress by using assigned keyboard keys. To block user input use <tt>blockuser</tt> param.}}
A [[Arma_3:_Event_Handlers#PeriscopeElevationChanged | PeriscopeElevationChanged]] entity event handler is also provided.|Description=


|mp= |Multiplayer Behaviour=
|mp= |Multiplayer Behaviour=
Line 13: Line 15:
____________________________________________________________________________________________
____________________________________________________________________________________________


|s1= TBD |Syntax=
|s1= vehicle [[elevatePeriscope]] [turret, elevation, speed, blockuser] |Syntax=
|p1= vehicle: [[Object]] - vehicle with periscope tech|Param1=
|p2= [turret, elevation, speed, blockuser]: [[Array]]|Param2=
|p3= turret: [[Array]] - turret on which periscope is located|Param3=
|p4= elevation: [[Number]] - elevation range 0...1|Param4=
|p5= speed (Optional): [[Number]] or [[Boolean]] - config anim speed multiplier, 2 - twice as fast, 0.5 - twice as low, etc. -1 - default config speed. If [[true]] is used as param, the change in elevation is almost instant.|Param5=
|p6= blockuser (Optional): [[Boolean]] - true to disable user ability to control periscope with keyboard. The change is persistent unless you set it to [[false]] again.|Param6=


|r1= |Return Value=
|r1= [[Nothing]]|Return Value=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>TBD</code> |Example 1=
|x1= <code>_eddie elevatePeriscope [<nowiki/>[0], 0.75, 0.1]];</code> |Example 1=
____________________________________________________________________________________________
____________________________________________________________________________________________


|seealso= [[periscopeElevation]]|See Also=
|seealso= [[periscopeElevation]], [[Arma_3:_Event_Handlers#PeriscopeElevationChanged | PeriscopeElevationChanged]] |See Also=
}}
}}



Revision as of 07:21, 10 September 2020

-wrong parameter ("arma3dev") defined!-[[:Category:Introduced with arma3dev version |?]]
Hover & click on the images for description

Description

Description:
Elevates periscope of a vehicle. Vehicles in Arma 3 which are compatible with this tech are Strider, remote laser designators, the robot arm on Eddie, etc. Please note that SDV submarine has a different periscope, which is just an animated selection and could be raised and lowered with animate command.
User can immediately override any elevation in progress by using assigned keyboard keys. To block user input use blockuser param.
A PeriscopeElevationChanged entity event handler is also provided.
Groups:
Uncategorised

Syntax

Syntax:
vehicle elevatePeriscope [turret, elevation, speed, blockuser]
Parameters:
vehicle: Object - vehicle with periscope tech
[turret, elevation, speed, blockuser]: Array
turret: Array - turret on which periscope is located
elevation: Number - elevation range 0...1
speed (Optional): Number or Boolean - config anim speed multiplier, 2 - twice as fast, 0.5 - twice as low, etc. -1 - default config speed. If true is used as param, the change in elevation is almost instant.
blockuser (Optional): Boolean - true to disable user ability to control periscope with keyboard. The change is persistent unless you set it to false again.
Return Value:
Nothing

Examples

Example 1:
_eddie elevatePeriscope [[0], 0.75, 0.1]];

Additional Information

See also:
periscopeElevation PeriscopeElevationChanged

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

[[Category:Introduced with arma3dev version ]][[ Category: arma3dev: New Scripting Commands | ELEVATEPERISCOPE]][[ Category: arma3dev: Scripting Commands | ELEVATEPERISCOPE]]

Bottom Section