pxlEnums

pxlEnums

new pxlEnums()

Description:

  • pxlNav Enums

    When a 'type' needs to be determined, enums help to show the available options.

Source:
Properties:
Name Type Description
pxlEnums Object

pxlNav {Enums} contains all the enums used in pxlNav
VERBOSE_LEVEL Object

Console logging levels
ANTI_ALIASING Object

Anti-aliasing settings
RENDER_LAYER Object

Render Order Layers
SKY_HAZE Object

Sky Haze settings
SHADOW_MAP Object

Shadow edge softness settings
CAMERA_EVENT Object

Camera event types
COLLIDER_TYPE Object

Collider internal types
GEOMETRY_SIDE Object

Geometry side types
COLOR_SHIFT Object

Color space conversion options
USER_SPEED Object

User speed settings
DEVICE_TYPE Object

Input-Device Types
DEVICE_EVENT Object

Input-Device Events
DEVICE_BUTTON Object

Input-Device Buttons
DEVICE_ACTION Object

Input-Device Actions
HUD_ELEMENT Object

GUI & HUD Element types
HUD_ACTION Object

GUI & HUD Element actions
HUD_DRAW Object

GUI & HUD Element draw types

Members

(static, constant) exports.pxlEnums :Object

Description:

  • pxlNav Enums

Source:
Properties:
Name Type Description
VERBOSE_LEVEL Object

Console logging levels
ANTI_ALIASING Object

Anti-aliasing settings
RENDER_LAYER Object

Render Order Layers
SKY_HAZE Object

Sky Haze settings
SHADOW_MAP Object

Shadow edge softness settings
CAMERA_EVENT Object

Camera event types
COLLIDER_TYPE Object

Collider internal types
GEOMETRY_SIDE Object

Geometry side types
COLOR_SHIFT Object

Color space conversion options
USER_SPEED Object

User speed settings
DEVICE_TYPE Object

Input-Device Types
DEVICE_EVENT Object

Input-Device Events
DEVICE_BUTTON Object

Input-Device Buttons
DEVICE_ACTION Object

Input-Device Actions
HUD_ELEMENT Object

GUI & HUD Element types
HUD_ACTION Object

GUI & HUD Element actions
HUD_DRAW Object

GUI & HUD Element draw types

pxlNav Enums

Type:
  • Object

Methods

(static) ANTI_ALIASING()

Description:

  • Anti-aliasing settings

Source:
Properties:
Name Type Description
OFF number

No anti-aliasing
LOW number

Low anti-aliasing
MEDIUM number

Medium anti-aliasing
HIGH number

High anti-aliasing

(static) CAMERA_EVENT()

Description:

  • Camera event types

Source:
Properties:
Name Type Description
MOVE number

Camera movement event
ROTATE number

Camera rotation event
JUMP number

Camera jump event
FALL number

Camera fall event
LANDED number

Camera landed event
COLLISION number

Camera collision event

(static) COLLIDER_TYPE()

Description:

  • Collider internal types

Source:
Properties:
Name Type Description
FLOOR number

Default ground/floor type collider
WALL number

Can't walk through, even if there is 'FLOOR' beneath it
WALL_TOP number

The Wall Top; Will be removed in future versions, use 'FLOOR' instead
CEILING number

Not implemented yet
PORTAL_WARP number

Warp to another location in the same room
ROOM_WARP number

Warp to another location in a different room
ITEM number

Callback to item list managed by pxlNav & from Room FBX
SCRIPTED number

Callback to current room on collision
HOVERABLE number

Mouse hoverable, but not clickable
CLICKABLE number

Mouse clickable

(static) COLOR_SHIFT()

Description:

  • Color space conversion options

Source:
Properties:
Name Type Description
KEEP number

Keep the color as is
sRGB_TO_LINEAR number

Convert sRGB to Linear color space
LINEAR_TO_sRGB number

Convert Linear to sRGB color space
WINDOWS_TO_UNIX number

Convert Windows color space to Unix color space
UNIX_TO_WINDOWS number

Convert Unix color space to Windows color space
LINEAR_TO_WINDOWS number

Convert Linear color space to Windows color space
WINDOWS_TO_LINEAR number

Convert Windows color space to Linear color space
LINEAR_TO_UNIX number

Convert Linear color space to Unix color space
UNIX_TO_LINEAR number

Convert Unix color space to Linear color space

(static) DEVICE_ACTION()

Description:

  • Input-Device Actions

Source:
Properties:
Name Type Description
MOVE number

Move action
MOVE_X number

Move X axis ( Unused )
MOVE_Y number

Move Y axis ( Unused )
LOOK number

Look action
LOOK_X number

Look X axis ( Unused )
LOOK_Y number

Look Y axis ( Unused )
JUMP number

Jump action
RUN number

Run action
ACTION number

Action button
ACTION_ALT number

Alternate action button ( Unused )
ITEM number

Item button
MENU number

Menu button ( Unused )
PAUSE number

Pause button
MAP number

Map button ( Unused )

(static) DEVICE_EVENT()

Description:

  • Input-Device Events

Source:
Properties:
Name Type Description
CONNECT number

Device connected
DISCONNECT number

Device disconnected
BUTTON_PRESS number

Button pressed
AXIS_MOVE number

Axis moved
AXIS_LOOK number

Axis looking

(static) DEVICE_TYPE()

Description:

  • Input-Device Types

Source:
Properties:
Name Type Description
KEYBOARD number

Keyboard input device
MOBILE number

Mobile input device
GAMEPAD number

Gamepad input device ( Unused )
XR number

Extended Reality input device ( Unused )
VR number

Virtual Reality input device ( Unused )
AR number

Augmented Reality input device ( Unused )
HMD number

Head Mounted Display input device ( Unused )
OTHER number

Other input device ( Unused )

(static) GEOMETRY_SIDE()

Description:

  • Geometry side types

Source:
Properties:
Name Type Description
FRONT number

Front side of the geometry
BACK number

Back side of the geometry
DOUBLE number

Both sides of the geometry

(static) HUD_ACTION()

Description:

  • GUI & HUD Element actions

Source:
Properties:
Name Type Description
NONE number

No action
CLICK number

Click action
HOVER number

Hover action
ACTIVE number

Active action
DRAG number

Drag action
DROP number

Drop action ( Unused )

(static) HUD_ELEMENT()

Description:

  • GUI & HUD Element types

Source:
Properties:
Name Type Description
REGION number

Region element
DRAG_REGION number

Drag Region element
BUTTON number

Button element
THUMBSTICK number

Thumbstick element
SLIDER number

Slider element ( Unused )
IMAGE number

Image element ( Unused )
TEXT number

Text element ( Unused )

(static) RENDER_LAYER()

Description:

  • Render Order Layers

Source:
Properties:
Name Type Description
SKY number

Sky layer
SCENE number

Scene layer
PARTICLES number

Particle layer
GLOW number

Glow layer
GLOW_MASK number

Glow mask layer

(static) SHADOW_MAP()

Description:

  • Shadow edge softness settings

Source:
Properties:
Name Type Description
OFF number

No shadow edge softness
BASIC number

Basic shadow edge softness
SOFT number

Soft shadow edge softness

(static) SKY_HAZE()

Description:

  • Sky Haze settings

Source:
Properties:
Name Type Description
OFF number

No sky haze
VAPOR number

Vapor sky haze

(static) USER_SPEED()

Description:

  • User speed settings

Source:
Properties:
Name Type Description
STOP number

Stop movement
SLOW number

Slow movement
BASE number

Base movement
BOOST number

Boosted movement

(static) VERBOSE_LEVEL()

Description:

  • Console logging levels

Source:
Properties:
Name Type Description
NONE number

No console logging
ERROR number

Log only errors
WARN number

Log errors and warnings
INFO number

Log errors, warnings, and info
DEBUG number

Log all console messages