Main Navigation Guide Examples API Changelog

Appearance

Sidebar Navigation

API reference

electron

Classes

SessionStore

WebPatcher

Interfaces

AppLike

ExternalPolicy

InputLike

IpcMainLike

LockdownOptions

PreventableLike

SafeStorageLike

SessionLike

SessionStoreOptions

ShellIdOptions

ShellLike

WebContentsLike

WebPatcherOptions

WebPointer

WindowLike

Type Aliases

PointerName

Variables

DEBUG_SWITCHES

Functions

debuggerRequested

denyPermissions

isAllowedExternal

isAllowedNavigation

isDevToolsKey

lockDownWindow

refuseDebugLaunch

registerSessionStore

shellId

index

Classes

Actions

Afterimages

AimGesture

Animator

AnimStateMachine

ApiClient

ApiError

AssetLoader

AtlasBuilder

Autosaver

BehaviorTree

Birds

BitmapLabel

Body

BtAgent

Butterflies

Camera

CanvasTexture

ChimneySmoke

Clock

ColorGrade

Connection

Contact

ContactPoint

CrossfadeTransition

DayClock

DebugOverlay

DialogueRunner

DitherWipeTransition

DrawCallCounter

Drift

Emitter

Engine

ErrorDeduper

ErrorLog

EventBus

FadeTransition

Fireflies

FixedLoop

FloatingText

Footsteps

FrameSampler

FrameStats

Graphics

Group

HapticGate

Haptics

HiddenPause

Image

InputCapture

InputPlayer

InputRecorder

InterpolationBuffer

Keyboard

Keymap

LagCompensator

Letterbox

LightLayer

LobbyClient

LobbyHost

LobbyRooms

LongPress

Matchmaker

MemoryBackend

MigrationError

MinHeap

MusicChannel

MusicPlayer

ObjectFactory

Parallax

ParallaxLayer

ParticleBudget

ParticleSim

PhysicsWorld

PixelGrid

Pointer

PosePlayer

PredictedMover

PrefabLibrary

Prepainter

Rectangle

RigView

Room

RoomHost

SaveStore

Scene

SceneManager

SharpText

Skeleton

SoundEngine

SpatialAudio

SpatialHash

Stage

TargetLock

Text

TextureRegistry

TilemapView

Timeline

TimelineBuilder

Translator

Tween

Tweener

WeatherLayer

WebStorageBackend

World

Interfaces

ActionOptions

ActionsOptions

AfterimagesOptions

AimGestureOptions

AnimationClip

AnimStateDef

AnimStateMachineOptions

AnimTransition

ApiClientOptions

ApiErrorInfo

ApiRequestOptions

AsepriteCue

AsepriteFrame

AsepriteJson

AsepriteJsonFrame

AsepriteJsonLayer

AsepriteJsonSlice

AsepriteJsonSliceKey

AsepriteJsonTag

AsepriteLayer

AsepriteRect

AsepriteSheet

AsepriteSlice

AsepriteSliceKey

AsepriteTag

AsepriteTextureSink

AssetLoaderOptions

AssetResponse

AtlasInfo

AtlasPage

AtlasPlan

AtlasSize

AutosaverOptions

AutosaveTimers

AutotileRule

AutotileRuleSet

AxisInput

AxisPlacement

BirdsOptions

BlendLayerOptions

BodyOptions

BootStall

BootWatch

BoxShape

BtNode

BtRegistry

BtRun

BtTraceLine

ButterfliesOptions

CameraLike

CapturedError

CaptureErrorsOptions

CaptureOptions

ChimneySmokeOptions

CircleShape

ClipMarker

ColliderColors

CollisionGrid

CollisionGridOptions

ColorGradeOptions

ComponentType

ConnectionEvents

ConnectionOptions

ContactInfo

ContextLossPolicy

ContextLossVerdict

CrossfadeOptions

DayClockOptions

DayKey

DayPhase

DayState

DebugOverlayOptions

DialogueBranch

DialogueChoice

DialogueEnd

DialogueIssue

DialogueLine

DialogueNode

DialogueOptions

DialogueSave

DialogueScript

DialogueValidateOptions

DitherWipeOptions

DriftOptions

DueCall

EmitterOptions

EngineEvents

EngineOptions

EngineSettings

EntityRow

ExprScope

ExtractedString

ExtractOptions

FadeOptions

FieldsType

FindPathOptions

FirefliesOptions

FixedLoopOptions

FloatingTextOptions

FloatingTextStyle

FloatOptions

FlowField

FlushableInput

FootstepOptions

FoundMatch

FrameSamplerOptions

FrameSummary

FullscreenDocument

Grade

GradeState

GridPlacement

HapticsOptions

HostSocket

InputTape

InterpolatedState

Joints

KeyChord

LdtkAssetOptions

LdtkEntity

LdtkIntGrid

LdtkLevel

LdtkParseOptions

LdtkProject

LdtkWorld

LetterboxOptions

LifeAir

LifeBox

LifePoint

Light

LightLayerOptions

LoadProgress

LobbyClientEvents

LobbyHostOptions

LobbyLink

LobbyMatch

LobbyRoom

LockBody

LoggedError

MapObject

MaskOptions

MatchMode

MatchPlayer

MotionQuery

MovementParams

MoverState

MusicOptions

MusicPlayOptions

NavGrid

NavOptions

ObjectLayer

OrientationTarget

PackedAtlasPage

PackedFrame

PadState

PaintedPixels

Painter

ParallaxCamera

ParallaxLayerOptions

ParallaxOptions

ParallelPolicy

PartSkin

Pausable

PendingMatch

PhysicsEvents

PhysicsWorldOptions

PixelZoomOptions

PointerLockDocument

PolygonShape

PoseClip

Positioned

Prefab

PrefabContext

PrefabOptions

PrepainterOptions

PrepainterTextures

PuffMotion

RaycastOptions

RayHit

ResumeEnv

RewoundBody

RewoundHit

RigDef

RigPoint

RigPose

RigViewOptions

RoomBody

RoomHostOptions

RoomInterest

RoomMember

RoomOptions

RoomPlayer

RoomState

RoomSummary

RumbleOptions

RumblePad

SaveBackend

SaveInfo

SaveStoreOptions

SceneTimer

ShownChoice

ShownChoices

ShownLine

Snapshot

SnapshotLike

SolverSettings

SoundOptions

SoundTable

SpatialEmitter

SpatialEmitterOptions

SpatialMix

SpatialMixOptions

SpawnInfo

SpawnOptions

SteerAgent

SteerVec

Steppable

StepSource

StickVector

SurfaceSounds

SynthLayer

SynthRecipe

System

SystemContext

TargetLockOptions

TerrainGrid

TextStyle

TextureSink

Ticket

TileBodiesOptions

TiledCollisionOptions

TileLayer

TileMap

TilemapAssetOptions

TilemapViewOptions

TilePoint

TileRect

Tileset

TimelineOptions

TimelineTweenOptions

TouchEnv

TrackOptions

Transition

TransitionContext

TranslatorOptions

TweenConfig

Vec2

ViewRect

WeatherEntry

WeatherLayerOptions

WeatherLook

WeatherSky

WeatherState

WeatherTable

WorkerPainterOptions

Type Aliases

AimEnd

AimShape

AnimationClips

AnimCondition

AnimParamDecl

AnimParams

ApiMethod

ArrayOf

AsepriteDirection

AsepriteLoadOptions

AtlasFrame

AutotileMode

Bindings

BodyType

BoxDrawer

BtSpec

BtStatus

Catalog

ClientMessage

ColliderBoxDrawer

ColliderLineDrawer

ColorCurve

Columns

CompareOp

CompiledExpr

ComponentValues

Curve

DialogueCommand

DialogueStep

DriftKind

EaseFn

Entity

EntityUpdate

ExprValue

Face

FieldKind

FieldSpec

FieldValues

GradePlacement

HapticGaps

HumanoidClip

InputDevice

InputStep

IntGridSolid

LdtkFieldValue

LdtkWorldLayout

LifeSource

Limb

LineDrawer

LoadFailure

LoadResult

LobbyClientMessage

LobbyErrorCode

LobbyServerMessage

MapLayer

Migrations

MoverWire

MusicRoute

NavGoal

OrientationLock

PaintReply

PluralForms

PrefabData

PrefabPart

PrefabValue

Properties

Range

RefreshResult

RigPart

RigSkin

RoomSeen

ServerMessage

SettingsListener

Shape

SpawnArea

SystemPhase

TiledPropertyValue

TimelinePosition

TimelineProps

TransitionMode

TweenTarget

WeatherMotion

WorldObject

Variables

AIM_CENTRE

AIM_EARLY_SLOP

AIM_PRESS_MS

AIM_TAP_SLOP

AnimationComponent

AnimStateComponent

BAYER4

BLOB_E

BLOB_N

BLOB_NE

BLOB_NW

BLOB_S

BLOB_SE

BLOB_SW

BLOB_W

BLOB47_MASKS

BODY_HALF_HEIGHT

BODY_HALF_WIDTH

BODY_ID_BASE

CADENCE

CLOSE_NO_ANSWER

COLLIDER_COLORS

CONTEXT_MARK

DIAGONAL

DITHER_LEVELS

EDGE_E

EDGE_N

EDGE_S

EDGE_W

engineSettings

FACE_BOTTOM

FACE_LEFT

FACE_RIGHT

FACE_TOP

FLIP_D

FLIP_H

FLIP_V

HEAVY_FLASH_GAP_MS

HUMANOID_CLIPS

HUMANOID_POSES

HUMANOID_RIG

INPUT_FLAG_DASH

INPUT_STEP_DT

INPUT_STEP_RATE

LOCK_KEEP_RANGE

LOCK_PICK_CONE

LOCK_PICK_RANGE

MAX_POLYGON_VERTICES

music

NAV_STEPS

PAD_BUTTONS

particleBudget

RECOIL_MS

RIG_PARTS

sound

SpriteComponent

STICK_DEAD_ZONE

SYNTH_RATE

TILE_SIZE

UPDATE_RECORD_BYTES

Functions

action

addAsepriteTextures

addLabelGlyphs

aimAxis

aimPoint

alignment

animationSystem

animStateSystem

applySteering

arrive

atlasPageLimit

autotile

autotileAt

balanceTeams

baseZoom

birdFrame

blendLayer

blendPose

blob47Index

blobMask

blocksShot

bodyCollides

bootWatch

boxInView

buildTree

cadenceEarly

cadenceNext

canStep

captureErrors

checksum

chordHeld

clearSilhouettes

clipMarkers

clockText

cohesion

collectAtlasPages

colliderColor

collisionFromIntGrid

collisionFromTiled

combineSteering

compileExpr

condition

cooldown

countHitches

createCollisionGrid

createMover

currentOrientationKind

decodeSnapshotFrame

decodeUpdates

defineComponent

defineFields

definePrefab

describeError

detectTouch

deviceOf

ditherCovered

dragSlop

drawColliders

dueParticles

duplicateFrames

easeByName

edgeMask

elementVolumeLocked

encodeSnapshotFrame

encodeUpdates

enterFullscreen

entitiesOf

entityIndex

exitFullscreen

exitPointerLock

extractStrings

fillSolid

findPath

firefliesOut

fireflyGlow

fireflyOffset

fitScale

flee

flockSlot

floodFill

flowField

followField

followFlow

followReducedMotion

formatMessage

formatTrace

frameNamed

fullscreenSupported

gidOf

gpuName

gradeAt

gridPlacement

guardRender

hash01

hasTakes

hitStopMs

hurtFlashGapMs

hurtFlashMs

inspectWorld

installLabelFont

intGridAt

invert

inView

isFullscreen

isOpen

isPointerLocked

isPrefabOf

isSolidTile

isTouchUi

keptTarget

keyLabel

keymapStorage

layerByName

ldtkExternalLevels

lerpColor

levelAt

levelByName

loadAseprite

loadLdtkLevel

lockOrientation

looksThrottled

maxTextureSize

mergeKeymap

mergeTileRects

migrateSave

mixRgb

mixToWhite

moverFromWire

moverToWire

moveX

moveY

navGrid

navGridFromCollision

nearestOpen

nearestTarget

nearWallCost

noteContextLoss

noteServerTime

objectsOf

octile

onAppResume

onFullscreenChange

onPointerLockChange

onReducedMotionChange

overlay

padLabel

paintTerrain

parallaxOrigin

parallel

parseAseprite

parseAtlas

parseChord

parseLdtk

parseTiled

percentile

physicsSystem

pickInView

pickTarget

placeAxis

planAtlas

polygonCentroid

polygonShape

prefabPart

prefersReducedMotion

puffOffset

quantizeUpdates

reachedCount

reactiveSelector

reactiveSequence

rebuildDelayMs

recoilAt

recoilPx

reconnectDelay

reduceBlobMask

registerSounds

registerTakes

regularPolygon

renderRecipe

repeat

requestPointerLock

resetServerClock

resolveUrl

retry

rumble

rumblePad

rumbleParams

runDue

sampleColor

sampleCurve

sampleRange

scaleCount

seededRandom

seek

selector

separation

sequence

serverNow

serverOffset

setNativeShell

setTouchOverrideKey

shouldReconnect

simplifyPath

sliceAt

sliceBorders

sliceNamed

solidSilhouette

sourceOf

sourceText

spanVisible

spatialMix

spawnPrefab

spotReach

spotShare

spreadAngle

stepMover

stickActive

stickToAxis

stickVector

stopRumble

straightenPath

succeed

summarizeFrames

syncToBody

system

tagDirection

tagFrames

tagRepeat

tileAt

tileBodies

tileBodiesFromGrid

tileRect

timeout

timeoutSignal

tintNight

toggleFullscreen

transitionTo

trimStack

tweenDone

unlockOrientation

updateAutotile

upperOver

validateDialogue

vibrate

wait

watchContextLoss

weatherAt

wipeLevel

workerPainter

worldZoom

wrap

zoomResolution

zoomSteps

mobile

Classes

BackStack

Interfaces

AppLike

DoubleBackOptions

Insets

ListenerHandle

MobileConfigOptions

WakeLockLike

Type Aliases

BackHandler

Functions

capacitorConfig

doubleBackToExit

installBackButton

keepScreenOn

nativeBuildOf

safeAreaInsets

pixel

Namespaces

pixelPaint

Type Aliases

FlightPixel

Point

Variables

WHITE

Functions

arc

blob

dashStreak

debris

diamond

dot

drop

dust

hline

outlined

pixelOn

puffBlob

ring

shards

snap

spark

stroke

tail

xMark

pixelTone

Interfaces

Ramp

Functions

batchFor

beginBatch

beginOutline

capturing

currentCoverage

derivedRamp

dithered

endBatch

endOutline

fillRuns

flushBatch

grade

pixelKey

ramp

record

registerHandRamps

setCoverage

stageRun

Classes

Darkness

DitherVignette

Evaporation

NightShade

PackedPixels

PixelGrid

PixelLayer

PixelMarks

PixelWindow

SwayProp

Interfaces

DarknessOptions

DeathPixels

DitherVignetteOptions

LifeArt

LifeColors

MarkTone

MaterialLight

NightShadeOptions

NineSlice

NineSliceSpec

PaintLayerOptions

PixelMarksOptions

PropArt

Ramp

SliceInsets

SpritePixel

SwayDef

SwayPropOptions

SwayRect

SwayRig

SwayStrip

SwayWind

TransientLight

WeatherColors

Type Aliases

BuiltinMaterial

Color

LifePixel

Material

PixelPoint

PixelRun

RampFactors

SwayMode

TuftRect

WeatherPixel

Variables

CARRIED_LIGHT

CLEAR

FRAME_CORNERS

FRAME_TWINS

LAMP_DIM

LIFE_COLORS

MATERIALS

NO_PIXELS

PALETTE

PUFF_FRAMES

RAMP_FACTOR_SET

WARM_LIGHT

WEATHER_COLORS

Functions

addPixelLayer

art

buildRig

carriedLight

channels

chevronPixels

clearLights

complement

discRuns

ditherVignette

ellipsePixels

flashLight

frameSvg

groundShadow

gustAt

hash2

heartbeat

hex

hueShade

litOutline

liveLights

makeSheet

mistPixels

mix

mulberry32

nineSlice

opaqueRowWidths

outlineOf

paintLayer

paintLifeArt

paintWeatherArt

puffPixels

ramp

rampTones

registerMaterial

rgba

ringPixels

selectiveOutline

shade

shadeBox

spritePixels

swayOffset

tileHash

toCss

trunkPivot

upscale

valueNoise

vignetteMask

withAlpha

postfx

Classes

BloomFilter

ChromaticAberrationFilter

ColorAdjustFilter

CrtFilter

FxAnimator

FxFilter

PixelateFilter

PostFx

ShockwaveFilter

VignetteFilter

Interfaces

BloomOptions

ColorAdjustOptions

CrtOptions

FlashOptions

FxAnimation

FxShaderSpec

FxUniform

PostFxOptions

ShockwaveOptions

ShockwaveRun

VignetteOptions

Type Aliases

FxUniforms

FxUniformType

Functions

glslSource

rgb

wgslSource

react

Interfaces

AskOptions

ChoiceOption

ChoiceQuestion

ConfirmButtonProps

ConfirmQuestion

CursorTipOptions

FitTarget

GlyphArt

GlyphProps

ListPlacement

ModalProps

PanelProps

PixelImageProps

SelectOption

SelectProps

SliderProps

SplitPaneProps

Tab

TabStripProps

TitleTipsProps

TooltipProps

UiLabels

UiProviderProps

UiSettings

Type Aliases

BuiltInGlyph

ClassJoiner

GlyphId

SelectingHook

Variables

baseCss

choiceStore

confirmStore

DEFAULT_LABELS

Glyph

SCROLL_CLASS

SPLIT_STACK_BELOW

Functions

answerChoice

answerConfirm

askChoice

askConfirm

askQuantity

cancelChoice

cancelConfirm

ChoiceDialog

classJoiner

ConfirmButton

ConfirmDialog

cursorTip

defaultUiSettings

fillLabel

firstChoice

glyphPath

hasGlyph

injectBaseCss

listPlacement

Modal

Panel

parseQuantity

pickedEntry

pixelFit

PixelImage

registerGlyph

Select

sheetScaleStyle

Slider

sliderKeyValue

splitModeFor

SplitPane

stepOption

TabStrip

TitleTips

Tooltip

UiProvider

useCx

useFillSheet

useFitToViewport

useJsonSelector

usePicked

useStore

useStoreJson

useUi

useViewport

windowStyle

ui

Classes

Bar

BitmapRichFont

Button

CanvasRichFont

Dialog

DomOverlay

DomWorldAnchors

FocusManager

InputShield

Label

List

Panel

RichText

ScrollView

Slider

Stack

Toggle

UiRoot

Widget

Interfaces

BarOptions

BitmapRichFontOptions

ButtonOptions

ButtonSkin

ColourSkin

DialogOptions

DomOverlayOptions

DrainOptions

DrainState

ElementLike

FitOptions

FitResult

Insets

LayerTransform

ListOptions

ListWidthOptions

NavBindings

NavInput

PanelOptions

Point

Rect

RichFont

RichFontOptions

RichIconItem

RichIconSpan

RichLayout

RichLayoutOptions

RichLine

RichMarkupOptions

RichMeasure

RichStyle

RichTextItem

RichTextOptions

RichTextSpan

ScrollViewOptions

ShieldFacts

ShieldOptions

Size

SliderOptions

StackOptions

StackResult

Store

TextureSkin

ToggleOptions

TooltipOptions

TooltipPlacement

UiHost

UiModal

UiRootOptions

UiTicking

WorldAnchorOptions

WorldPoint

Type Aliases

ButtonState

LabelText

NavDirection

PanelSkin

RichAlign

RichItem

RichSpan

ScreenAnchor

StackAlign

StackDirection

StoreListener

TipSide

Variables

DEFAULT_NAV

FLING_STOP

UiPointerGate

Functions

anchorPosition

clamp

clampScroll

createStore

drainState

escapeRichText

firstFocus

fitToViewport

insets

isEditable

isInside

layoutRichText

linearFocus

listWidth

maxScroll

nextFocus

onScreen

parseRichText

placeTooltip

quantize

scrollIntoView

setDrainValue

shouldShield

sizeOf

sliderFraction

sliderValueAt

snapPx

snapRect

stackLayout

stepDrain

stepFling

stripRichText

uiHostOf

worldToScreen

wrapRow

updates

Interfaces

LatestJson

NewerRelease

PluginEntry

ReleaseFile

WebBundle

WebFile

WebManifest

WebPlan

Functions

apkUpdateOf

fileUrl

heldBundle

isNewer

isSha256

pickWebUpdate

planWeb

pluginEntries

safePath

validManifest

On this page

1681-engine

Modules

electron
index
mobile
pixel
postfx
react
ui
updates

Edit this page on GitHub

Pager

Next pageelectron

Released under the MIT License.

pixelPaint

Type Aliases

Variables

Functions

pixelTone

Interfaces

Functions

1681-engine ​

Modules ​

1681-engine

Modules