elevatePeriscope: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *[Pp]aram *[0-9]* *= * " to " ")
m (Some wiki formatting)
 
(6 intermediate revisions by the same user not shown)
Line 2: Line 2:


|game1= arma3
|game1= arma3
|version1= 2.00
|version1= 2.00


Line 9: Line 8:
|gr2= Animations
|gr2= Animations


|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.  
|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.
{{Feature | Informative | User can immediately override any elevation in progress by using assigned keyboard keys. To block user input use <tt>blockuser</tt> param.}}
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 [[Arma_3:_Event_Handlers#PeriscopeElevationChanged | PeriscopeElevationChanged]] entity event handler is also provided.
{{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]
 
|p1= vehicle: [[Object]] - vehicle with periscope tech
 
|p2= turret: [[Array]] - turret on which periscope is located


|mp=
|p3= elevation: [[Number]] - elevation range 0..1


|pr=
|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


|s1= vehicle [[elevatePeriscope]] [turret, elevation, speed, blockuser]
|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
|p1= vehicle: [[Object]] - vehicle with periscope tech
|p2= [turret, elevation, speed, blockuser]: [[Array]]
|p3= turret: [[Array]] - turret on which periscope is located
|p4= elevation: [[Number]] - elevation range 0...1
|p5= speed (Optional): [[Number]] or [[Boolean]] - 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.
|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.


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>_eddie [[elevatePeriscope]] [<nowiki/>[0], 0.75, 0.1];</code>
|x1= <sqf>_eddie elevatePeriscope [[0], 0.75, 0.1];</sqf>


|seealso= [[periscopeElevation]], [[animate]], [[Arma_3:_Event_Handlers#PeriscopeElevationChanged | PeriscopeElevationChanged]]
|seealso= [[periscopeElevation]] [[animate]] [[Arma 3: Event Handlers#PeriscopeElevationChanged|PeriscopeElevationChanged Event Handler]]
}}
}}

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 ManipulationAnimations

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