rojo/.cursor/rules/roblox/reference/engine/enums/ScreenOrientation.yaml
2026-02-02 12:08:47 -06:00

52 lines
1.7 KiB
YAML

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
name: ScreenOrientation
type: enum
summary: |
The preference of in-game screen orientation on hand-held devices.
description: |
Indicates what orientation the game prefers to be played on mobile devices.
code_samples: []
tags: []
deprecation_message: ''
items:
- name: LandscapeLeft
summary: |
A preference where the game is displayed landscape (horizontally) with the
bottom of the device on the left side of the screen.
value: 0
tags: []
deprecation_message: ''
- name: LandscapeRight
summary: |
A preference where the game is displayed landscape (horizontally) with the
bottom of the device on the right side of the screen.
value: 1
tags: []
deprecation_message: ''
- name: LandscapeSensor
summary: |
A preference where the game is displayed landscape (horizontally) with the
bottom of the device on the left of right side of the screen depending on
the device's orientation (the sensor determines which side allows for the
game to be displayed right-side-up).
value: 2
tags: []
deprecation_message: ''
- name: Portrait
summary: |
A preference where the game is displayed portrait (vertically) with the
bottom of the device on the bottom of the screen.
value: 3
tags: []
deprecation_message: ''
- name: Sensor
summary: |
A preference where the game is displayed depending on the best match to
the device's current orientation - either landscape (left/right) or
portrait.
value: 4
tags: []
deprecation_message: ''