elevatePeriscope: Difference between revisions

Latest revision as of 11:42, 4 May 2022

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.

ⓘ

a user can immediately override any elevation in progress by using assigned keyboard keys. To block user input see the blockUserInput parameter.
a PeriscopeElevationChanged entity event handler is also provided.

Groups:

Object Manipulation Animations

Syntax

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

Examples

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

Additional Information

See also:: periscopeElevation animate PeriscopeElevationChanged Event Handler

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

@@ Line 1: / Line 1: @@
-{{Command
+{{RV|type=command
-|game1= arma3dev |Game name=
+|game1= arma3
+|version1= 2.00
-|version= 1.99 |Game version=
+|gr1= Object Manipulation
-____________________________________________________________________________________________
-|descr= TBD. {{wip}} |Description=
+|gr2= Animations
-|mp= |Multiplayer Behaviour=
+|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.
+{{Feature|informative|
+* a user can immediately override any elevation in progress by using assigned keyboard keys. To block user input see the ''blockUserInput'' parameter.
+* a [[Arma 3: Event Handlers#PeriscopeElevationChanged|PeriscopeElevationChanged]] entity event handler is also provided.
+}}
+|s1= vehicle [[elevatePeriscope]] [turret, elevation, speed, blockUserInput]
-|pr= |Problems=
+|p1= vehicle: [[Object]] - vehicle with periscope tech
-____________________________________________________________________________________________
-|s1= TBD |Syntax=
+|p2= turret: [[Array]] - turret on which periscope is located
-|r1= |Return Value=
+|p3= elevation: [[Number]] - elevation range 0..1
-____________________________________________________________________________________________
-|x1= <code>TBD</code> |Example 1=
+|p4= speed: [[Number]] or [[Boolean]] - (Optional, default -1) config anim speed multiplier, 2 - twice as fast, 0.5 - twice as slow, etc. -1 - default config speed. If [[true]] is used as param, the change in elevation is almost instant
-____________________________________________________________________________________________
-|seealso= [[periscopeElevation]]|See Also=
+|p5= blockUserInput: [[Boolean]] - (Optional, default [[false]]) [[true]] to disable user ability to control periscope with keyboard. The change is persistent unless set to [[false]] again
-}}
-<dl class="command_description">
+|r1= [[Nothing]]
-<!-- BEGIN Note Section -->
-<!-- END Note Section -->
+|x1= <sqf>_eddie elevatePeriscope [[0], 0.75, 0.1];</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[periscopeElevation]] [[animate]] [[Arma 3: Event Handlers#PeriscopeElevationChanged|PeriscopeElevationChanged Event Handler]]
+}}