Search
Preparing search index...
The search index is not available
@geps/geofs-types
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@geps/geofs-types
controls
Module controls
Can be accessed with
controls
.
Index
Interfaces
Setter
Variables
add
Hammer
Handlers
Are
Set
airbrakes
autopilot
axis
Setters
brakes
control
Key
Pressed
control
Pad
elevator
Trim
elevator
Trim
Max
elevator
Trim
Min
elevator
Trim
Step
engine
exponential
flaps
gear
joystick
keyboard
mix
Yaw
Roll
mix
Yaw
Roll
Quantity
mode
mouse
multiplier
optional
Animated
Part
orientation
pitch
raw
Pitch
reverse
roll
rudder
Pad
sensitivity
setters
states
throttle
throttle
Pad
touch
viewport
Height
viewport
Width
yaw
Functions
add
Hammer
Handlers
animate
Part
init
init
Viewport
Dimensions
key
Down
key
Up
mouse
Down
Handler
mouse
Handler
mouse
Up
Handler
recenter
reset
reset
With
Aircraft
Definition
set
Mode
set
Part
Animation
Delta
trim
Down
trim
Up
update
update
Keyboard
update
Mouse
update
Orientation
update
Touch
Variables
add
Hammer
Handlers
Are
Set
add
Hammer
Handlers
Are
Set
:
boolean
airbrakes
airbrakes
:
{
delta
?:
number
;
position
:
number
;
positionTarget
?:
number
;
target
:
number
}
Type declaration
Optional
delta
?:
number
position
:
number
Optional
position
Target
?:
number
target
:
number
autopilot
autopilot
:
{
$autopilotPad
?:
JQuery
;
PIDs
:
{
aileronsRoll
:
PID
;
bankAngle
:
PID
;
elevatorPitch
:
PID
;
pitchAngle
:
PID
;
throttle
:
PID
}
;
altitude
:
number
;
autopilotPadTimeout
:
number
;
climbrate
:
number
|
null
;
defaults
:
{
aileronsRollPID
:
number
[]
;
altitude
:
number
;
bankAnglePID
:
number
[]
;
baseClimbrate
:
number
;
baseDescentrate
:
number
;
climbrate
:
number
;
effectivenessRatioMaximum
:
number
;
elevatorPitchPID
:
number
[]
;
heading
:
number
;
kias
:
number
;
maxBankAngle
:
number
;
maxClimbrate
:
number
;
maxDescentrate
:
number
;
maxPitchAngle
:
number
;
minPitchAngle
:
number
;
pitchAnglePID
:
number
[]
;
targetBankAngleRatio
:
number
;
throttlePID
:
number
[]
;
verticalSpeedHoldMargin
:
number
;
yawBankAngleRatio
:
number
}
;
definition
:
typeof
defaults
;
heading
:
number
;
kias
:
number
;
on
:
boolean
;
init
:
any
;
initUI
:
any
;
resetPIDs
:
any
;
setAltitude
:
any
;
setClimbrate
:
any
;
setHeading
:
any
;
setKias
:
any
;
toggle
:
any
;
turnOff
:
any
;
turnOn
:
any
;
update
:
any
}
Type declaration
Optional
$autopilot
Pad
?:
JQuery
PIDs
:
{
aileronsRoll
:
PID
;
bankAngle
:
PID
;
elevatorPitch
:
PID
;
pitchAngle
:
PID
;
throttle
:
PID
}
ailerons
Roll
:
PID
bank
Angle
:
PID
elevator
Pitch
:
PID
pitch
Angle
:
PID
throttle
:
PID
altitude
:
number
autopilot
Pad
Timeout
:
number
climbrate
:
number
|
null
defaults
:
{
aileronsRollPID
:
number
[]
;
altitude
:
number
;
bankAnglePID
:
number
[]
;
baseClimbrate
:
number
;
baseDescentrate
:
number
;
climbrate
:
number
;
effectivenessRatioMaximum
:
number
;
elevatorPitchPID
:
number
[]
;
heading
:
number
;
kias
:
number
;
maxBankAngle
:
number
;
maxClimbrate
:
number
;
maxDescentrate
:
number
;
maxPitchAngle
:
number
;
minPitchAngle
:
number
;
pitchAnglePID
:
number
[]
;
targetBankAngleRatio
:
number
;
throttlePID
:
number
[]
;
verticalSpeedHoldMargin
:
number
;
yawBankAngleRatio
:
number
}
ailerons
RollPID
:
number
[]
altitude
:
number
bank
AnglePID
:
number
[]
base
Climbrate
:
number
base
Descentrate
:
number
climbrate
:
number
effectiveness
Ratio
Maximum
:
number
elevator
PitchPID
:
number
[]
heading
:
number
kias
:
number
max
Bank
Angle
:
number
max
Climbrate
:
number
max
Descentrate
:
number
max
Pitch
Angle
:
number
min
Pitch
Angle
:
number
pitch
AnglePID
:
number
[]
target
Bank
Angle
Ratio
:
number
throttlePID
:
number
[]
vertical
Speed
Hold
Margin
:
number
yaw
Bank
Angle
Ratio
:
number
definition
:
typeof
defaults
heading
:
number
kias
:
number
on
:
boolean
init
:
function
init
(
)
:
void
Returns
void
initUI
:
function
initUI
(
)
:
void
Returns
void
resetPIDs
:
function
resetPIDs
(
)
:
void
Returns
void
set
Altitude
:
function
set
Altitude
(
a
:
string
|
number
)
:
void
Parameters
a:
string
|
number
Returns
void
set
Climbrate
:
function
set
Climbrate
(
a
?:
string
|
number
)
:
void
Parameters
Optional
a:
string
|
number
Returns
void
set
Heading
:
function
set
Heading
(
a
:
string
|
number
)
:
void
Parameters
a:
string
|
number
Returns
void
set
Kias
:
function
set
Kias
(
a
:
string
|
number
)
:
void
Parameters
a:
string
|
number
Returns
void
toggle
:
function
toggle
(
)
:
void
Returns
void
turn
Off
:
function
turn
Off
(
)
:
void
Returns
void
turn
On
:
function
turn
On
(
)
:
void
Returns
void
update
:
function
update
(
a
:
number
)
:
void
Parameters
a:
number
Returns
void
axis
Setters
axis
Setters
:
{
airbrakesPosition
:
{
label
:
string
;
process
:
any
}
;
brakes
:
{
label
:
string
;
process
:
any
}
;
hatView
:
{
label
:
string
;
max
:
number
;
process
:
any
}
;
lookAround
:
{
label
:
string
;
process
:
any
}
;
lookUpDown
:
{
label
:
string
;
process
:
any
}
;
none
:
{
label
:
string
;
value
:
null
}
;
pitch
:
{
label
:
string
;
process
:
any
}
;
reverse
:
{
label
:
string
;
process
:
any
}
;
roll
:
{
label
:
string
;
process
:
any
}
;
throttle
:
{
label
:
string
;
process
:
any
}
;
throttlereverse
:
{
label
:
string
;
process
:
any
}
;
yaw
:
{
label
:
string
;
process
:
any
}
}
Type declaration
airbrakes
Position
:
{
label
:
string
;
process
:
any
}
label
:
string
process
:
function
process
(
a
:
number
)
:
void
Parameters
a:
number
Returns
void
brakes
:
{
label
:
string
;
process
:
any
}
label
:
string
process
:
function
process
(
a
:
number
)
:
number
Parameters
a:
number
Returns
number
hat
View
:
{
label
:
string
;
max
:
number
;
process
:
any
}
label
:
string
max
:
number
process
:
function
process
(
a
:
number
, b
:
number
)
:
void
Parameters
a:
number
b:
number
Returns
void
look
Around
:
{
label
:
string
;
process
:
any
}
label
:
string
process
:
function
process
(
a
:
number
)
:
void
Parameters
a:
number
Returns
void
look
Up
Down
:
{
label
:
string
;
process
:
any
}
label
:
string
process
:
function
process
(
a
:
number
)
:
void
Parameters
a:
number
Returns
void
none
:
{
label
:
string
;
value
:
null
}
label
:
string
value
:
null
pitch
:
{
label
:
string
;
process
:
any
}
label
:
string
process
:
function
process
(
a
:
number
)
:
number
Parameters
a:
number
Returns
number
reverse
:
{
label
:
string
;
process
:
any
}
label
:
string
process
:
function
process
(
a
:
number
)
:
number
Parameters
a:
number
Returns
number
roll
:
{
label
:
string
;
process
:
any
}
label
:
string
process
:
function
process
(
a
:
number
)
:
number
Parameters
a:
number
Returns
number
throttle
:
{
label
:
string
;
process
:
any
}
label
:
string
process
:
function
process
(
a
:
number
)
:
number
Parameters
a:
number
Returns
number
throttlereverse
:
{
label
:
string
;
process
:
any
}
label
:
string
process
:
function
process
(
a
:
number
)
:
number
Parameters
a:
number
Returns
number
yaw
:
{
label
:
string
;
process
:
any
}
label
:
string
process
:
function
process
(
a
:
number
)
:
number
Parameters
a:
number
Returns
number
brakes
brakes
:
number
control
Key
Pressed
control
Key
Pressed
:
boolean
control
Pad
control
Pad
:
HTMLElement
&
{
eX
:
number
;
hY
:
number
;
oX
:
number
;
offsetLeft
:
number
;
offsetTop
:
number
;
rX
:
number
;
rY
:
number
}
|
undefined
elevator
Trim
elevator
Trim
:
number
elevator
Trim
Max
elevator
Trim
Max
:
number
elevator
Trim
Min
elevator
Trim
Min
:
number
elevator
Trim
Step
elevator
Trim
Step
:
number
engine
engine
:
{
on
:
boolean
}
Type declaration
on
:
boolean
exponential
exponential
:
number
flaps
flaps
:
{
delta
?:
number
;
maxPosition
:
number
;
position
:
number
;
positionTarget
?:
number
;
target
:
number
}
Type declaration
Optional
delta
?:
number
max
Position
:
number
position
:
number
Optional
position
Target
?:
number
target
:
number
gear
gear
:
{
delta
?:
number
;
position
:
number
;
positionTarget
?:
number
;
target
:
number
}
Type declaration
Optional
delta
?:
number
position
:
number
Optional
position
Target
?:
number
target
:
number
joystick
joystick
:
{
api
:
typeof
navigator.getGamepads
;
axes
:
{}
;
buttonHandlers
:
[
]
&
{}
;
buttons
:
{}
;
deadZoneDown
:
number
;
deadZoneUp
:
number
;
info
:
string
;
oldButtonsValue
:
number
;
ready
:
boolean
;
sticks
:
Gamepad
[]
;
sticksNumber
:
number
;
addButtonListener
:
any
;
checkButton
:
any
;
configure
:
any
;
getAxisValue
:
any
;
init
:
any
;
poll
:
any
;
updateJoystick
:
any
}
Type declaration
api
:
typeof
navigator.getGamepads
axes
:
{}
[
key:
string
]:
{
enabled
:
boolean
;
globalId
:
number
;
id
:
string
;
stick
:
Gamepad
}
enabled
:
boolean
global
Id
:
number
id
:
string
stick
:
Gamepad
button
Handlers
:
[
]
&
{}
buttons
:
{}
[
key:
string
]:
{
globalId
:
number
;
id
:
string
;
stick
:
Gamepad
}
global
Id
:
number
id
:
string
stick
:
Gamepad
dead
Zone
Down
:
number
dead
Zone
Up
:
number
info
:
string
old
Buttons
Value
:
number
ready
:
boolean
sticks
:
Gamepad
[]
sticks
Number
:
number
add
Button
Listener
:
function
add
Button
Listener
(
a
:
string
, b
:
string
, c
:
(
(
)
=>
void
)
)
:
void
Parameters
a:
string
b:
string
c:
(
(
)
=>
void
)
(
)
:
void
Returns
void
Returns
void
check
Button
:
function
check
Button
(
a
:
string
)
:
boolean
Parameters
a:
string
Returns
boolean
configure
:
function
configure
(
)
:
void
Returns
void
get
Axis
Value
:
function
get
Axis
Value
(
a
:
string
, b
?:
number
, c
?:
number
)
:
number
Parameters
a:
string
Optional
b:
number
Optional
c:
number
Returns
number
init
:
function
init
(
)
:
void
Returns
void
poll
:
function
poll
(
)
:
boolean
Returns
boolean
update
Joystick
:
function
update
Joystick
(
a
:
number
)
:
void
Parameters
a:
number
Returns
void
keyboard
keyboard
:
{
exponential
:
number
;
override
:
boolean
;
overrideRudder
:
boolean
;
pitchIncrement
:
number
;
recenterRatio
:
number
;
rollIncrement
:
number
;
throttleIncrement
:
number
;
yawIncrement
:
number
}
Type declaration
exponential
:
number
override
:
boolean
override
Rudder
:
boolean
pitch
Increment
:
number
recenter
Ratio
:
number
roll
Increment
:
number
throttle
Increment
:
number
yaw
Increment
:
number
mix
Yaw
Roll
mix
Yaw
Roll
:
boolean
mix
Yaw
Roll
Quantity
mix
Yaw
Roll
Quantity
:
number
mode
mode
:
"mouse"
|
"keyboard"
|
"orientation"
|
"touch"
|
"joystick"
mouse
mouse
:
{
cX
:
number
;
cY
:
number
;
clickedNode
:
Cesium.Model
;
down
:
boolean
;
lastX
:
number
;
lastY
:
number
;
oX
:
number
;
oY
:
number
;
offset
:
{
ratioX
:
number
;
ratioY
:
number
}
;
orbit
:
{
ratioX
:
number
;
ratioY
:
number
;
ratioZ
:
number
}
;
originalX
:
number
;
originalY
:
number
;
rX
:
number
;
rY
:
number
;
tY
:
number
;
xValue
:
number
;
yValue
:
number
}
Type declaration
cX
:
number
cY
:
number
clicked
Node
:
Cesium.Model
down
:
boolean
lastX
:
number
lastY
:
number
oX
:
number
oY
:
number
offset
:
{
ratioX
:
number
;
ratioY
:
number
}
ratioX
:
number
ratioY
:
number
orbit
:
{
ratioX
:
number
;
ratioY
:
number
;
ratioZ
:
number
}
ratioX
:
number
ratioY
:
number
ratioZ
:
number
originalX
:
number
originalY
:
number
rX
:
number
rY
:
number
tY
:
number
x
Value
:
number
y
Value
:
number
multiplier
multiplier
:
{
pitch
:
number
;
roll
:
number
;
throttle
?:
number
;
yaw
:
number
}
Type declaration
pitch
:
number
roll
:
number
Optional
throttle
?:
number
yaw
:
number
optional
Animated
Part
optional
Animated
Part
:
{
delta
?:
number
;
position
:
number
;
positionTarget
?:
number
;
target
:
number
}
Type declaration
Optional
delta
?:
number
position
:
number
Optional
position
Target
?:
number
target
:
number
orientation
orientation
:
{
available
:
boolean
;
centers
?:
number
[]
|
null
;
eventListenerSet
?:
boolean
;
generalMultiplier
:
number
;
values
:
number
[]
;
fixPitch
:
any
;
getHtr
:
any
;
getNormalizedAxis
:
any
;
init
:
any
;
isAvailable
:
any
;
recenter
:
any
}
Type declaration
available
:
boolean
Optional
centers
?:
number
[]
|
null
Optional
event
Listener
Set
?:
boolean
general
Multiplier
:
number
values
:
number
[]
fix
Pitch
:
function
fix
Pitch
(
a
?:
number
[]
)
:
void
Parameters
Optional
a:
number
[]
Returns
void
get
Htr
:
function
get
Htr
(
)
:
number
[]
Returns
number
[]
get
Normalized
Axis
:
function
get
Normalized
Axis
(
a
:
number
)
:
number
|
void
Parameters
a:
number
Returns
number
|
void
init
:
function
init
(
)
:
void
Returns
void
is
Available
:
function
is
Available
(
)
:
boolean
Returns
boolean
recenter
:
function
recenter
(
)
:
void
Returns
void
pitch
pitch
:
number
raw
Pitch
raw
Pitch
:
number
reverse
reverse
:
number
roll
roll
:
number
rudder
Pad
rudder
Pad
:
HTMLElement
&
{
eX
:
number
;
oX
:
number
;
offsetLeft
:
number
;
rX
:
number
}
|
undefined
sensitivity
sensitivity
:
number
setters
setters
:
{
cycleFlaps
:
Setter
;
decreaseThrottle
:
Setter
;
increaseThrottle
:
Setter
;
none
:
Setter
;
setAirbrakes
:
Setter
;
setBrakes
:
Setter
;
setElevatorTrimDown
:
Setter
;
setElevatorTrimNeutral
:
Setter
;
setElevatorTrimUp
:
Setter
;
setFlapsDown
:
Setter
;
setFlapsUp
:
Setter
;
setGear
:
Setter
;
setOptionalAnimatedPart
:
Setter
;
setReverseFull
:
Setter
;
setReverseNone
:
Setter
;
setReverseOnThrottleAxis
:
Setter
;
toggleAutoPilot
:
Setter
;
toggleParkingBrake
:
Setter
;
toggleReverse
:
Setter
}
Type declaration
[
key:
string
]:
Setter
cycle
Flaps
:
Setter
decrease
Throttle
:
Setter
increase
Throttle
:
Setter
none
:
Setter
set
Airbrakes
:
Setter
set
Brakes
:
Setter
set
Elevator
Trim
Down
:
Setter
set
Elevator
Trim
Neutral
:
Setter
set
Elevator
Trim
Up
:
Setter
set
Flaps
Down
:
Setter
set
Flaps
Up
:
Setter
set
Gear
:
Setter
set
Optional
Animated
Part
:
Setter
set
Reverse
Full
:
Setter
set
Reverse
None
:
Setter
set
Reverse
On
Throttle
Axis
:
Setter
toggle
Auto
Pilot
:
Setter
toggle
Parking
Brake
:
Setter
toggle
Reverse
:
Setter
states
states
:
{
decreaseThrottle
:
boolean
;
down
:
boolean
;
increaseThrottle
:
boolean
;
left
:
boolean
;
right
:
boolean
;
rudderLeft
:
boolean
;
rudderRight
:
boolean
;
up
:
boolean
}
Type declaration
decrease
Throttle
:
boolean
down
:
boolean
increase
Throttle
:
boolean
left
:
boolean
right
:
boolean
rudder
Left
:
boolean
rudder
Right
:
boolean
up
:
boolean
throttle
throttle
:
number
throttle
Pad
throttle
Pad
:
HTMLElement
&
{
hY
:
number
;
offsetHeight
:
number
;
offsetTop
:
number
;
rY
:
number
;
tY
:
number
}
|
undefined
touch
touch
:
{
pitch
:
number
;
roll
:
number
;
throttle
:
number
;
yaw
:
number
}
Type declaration
pitch
:
number
roll
:
number
throttle
:
number
yaw
:
number
viewport
Height
viewport
Height
:
number
viewport
Width
viewport
Width
:
number
yaw
yaw
:
number
Functions
add
Hammer
Handlers
add
Hammer
Handlers
(
)
:
void
Returns
void
animate
Part
animate
Part
(
a
:
string
, b
:
number
)
:
void
Parameters
a:
string
b:
number
Returns
void
init
init
(
)
:
void
Returns
void
init
Viewport
Dimensions
init
Viewport
Dimensions
(
)
:
void
Returns
void
key
Down
key
Down
(
a
:
TypeEventHandler
<
Document
,
undefined
,
Document
,
Document
,
"keydown"
>
)
:
void
Parameters
a:
TypeEventHandler
<
Document
,
undefined
,
Document
,
Document
,
"keydown"
>
Returns
void
key
Up
key
Up
(
a
:
TypeEventHandler
<
Document
,
undefined
,
Document
,
Document
,
"keyup"
>
)
:
void
Parameters
a:
TypeEventHandler
<
Document
,
undefined
,
Document
,
Document
,
"keyup"
>
Returns
void
mouse
Down
Handler
mouse
Down
Handler
(
a
:
TypeEventHandler
<
Document
,
undefined
,
any
,
any
,
"mousedown"
>
)
:
void
Parameters
a:
TypeEventHandler
<
Document
,
undefined
,
any
,
any
,
"mousedown"
>
Returns
void
mouse
Handler
mouse
Handler
(
a
:
TypeEventHandler
<
Document
,
undefined
,
Document
,
Document
,
"mousemove"
>
)
:
void
Parameters
a:
TypeEventHandler
<
Document
,
undefined
,
Document
,
Document
,
"mousemove"
>
Returns
void
mouse
Up
Handler
mouse
Up
Handler
(
a
:
TypeEventHandler
<
Document
,
undefined
,
any
,
any
,
"mouseup"
>
)
:
void
Parameters
a:
TypeEventHandler
<
Document
,
undefined
,
any
,
any
,
"mouseup"
>
Returns
void
recenter
recenter
(
)
:
void
Returns
void
reset
reset
(
)
:
void
Returns
void
reset
With
Aircraft
Definition
reset
With
Aircraft
Definition
(
)
:
void
Returns
void
set
Mode
set
Mode
(
a
?:
string
)
:
void
Parameters
Optional
a:
string
Returns
void
set
Part
Animation
Delta
set
Part
Animation
Delta
(
a
:
number
)
:
void
Parameters
a:
number
Returns
void
trim
Down
trim
Down
(
a
?:
number
)
:
void
Parameters
Optional
a:
number
Returns
void
trim
Up
trim
Up
(
a
?:
number
)
:
void
Parameters
Optional
a:
number
Returns
void
update
update
(
a
:
number
)
:
void
Parameters
a:
number
Returns
void
update
Keyboard
update
Keyboard
(
a
:
number
)
:
void
Parameters
a:
number
Returns
void
update
Mouse
update
Mouse
(
a
?:
number
)
:
void
Parameters
Optional
a:
number
Returns
void
update
Orientation
update
Orientation
(
a
:
number
)
:
void
Parameters
a:
number
Returns
void
update
Touch
update
Touch
(
a
?:
number
)
:
void
Parameters
Optional
a:
number
Returns
void
Modules
aircraft
aircraft
Definition
animations
api
audio
camera
chat
controls
debug
flight
fx
geofs
globals
hud
instruments
multiplayer
objects
preferences
runways
ui
utils
vr
weather
Setter
add
Hammer
Handlers
Are
Set
airbrakes
autopilot
axis
Setters
brakes
control
Key
Pressed
control
Pad
elevator
Trim
elevator
Trim
Max
elevator
Trim
Min
elevator
Trim
Step
engine
exponential
flaps
gear
joystick
keyboard
mix
Yaw
Roll
mix
Yaw
Roll
Quantity
mode
mouse
multiplier
optional
Animated
Part
orientation
pitch
raw
Pitch
reverse
roll
rudder
Pad
sensitivity
setters
states
throttle
throttle
Pad
touch
viewport
Height
viewport
Width
yaw
add
Hammer
Handlers
animate
Part
init
init
Viewport
Dimensions
key
Down
key
Up
mouse
Down
Handler
mouse
Handler
mouse
Up
Handler
recenter
reset
reset
With
Aircraft
Definition
set
Mode
set
Part
Animation
Delta
trim
Down
trim
Up
update
update
Keyboard
update
Mouse
update
Orientation
update
Touch
Generated using
TypeDoc
Can be accessed with
controls.