Skip to content

Enums

Many of the Lua functions in the Alarmo depend on the use of core enums to accomplish tasks.

ShiroEnum

The Alarmo has a single core class called ShiroEnum, which is where the other enums are stored and referenced from.

For example, to reference the ViewportId and LayoutTextAlign enums, you could do something like the following:

--
-- Load the enum tables
--
local ViewportId = require("ShiroEnum.ViewportId")
local LayoutTextAlign = require("ShiroEnum.LayoutTextAlign")

--
-- Reference the enum values
--
local SomeTable = {
    viewport = ViewportId.Main,
    align = LayoutTextAlign.Center
}

AchievementFlag

Name Value
FirstTutorialCompleted 0
FirstAlarmCompleted 1
FirstAlarmSetCompleted 2
MorningRecordOpened 3
BedTimeRecordOpened 4
MovementRecordOpened 5

AlarmDayMode

Name Value
On 0
Off 1
Custom 2

AlarmLeaveType

Name Value
Invalid -1
LeaveNormal 0
LeaveBack 1
LeaveButton 2
ForceShutdown 3
CompletelyAbsence 4
TimeOut 5

AlarmMode

Name Value
Normal 0
Simple 1
Button 2
Middle 3

AlarmResultFlag

Name Value
IsHurryUp 1
TimeOut 2
AbsenceFromStart 4
LeaveDetected 8

BatteryChargingPortType

Name Value
Unknown 0
StandardDownstreamPort 1
ChargingDownstreamPort 2
DedicatedChargingPort 3

CanvasColorFormat

Name Value
Invalid 0
Argb8888 1
Argb1555 2
Argb4444 3
A4 4

ConnectionState

Name Value
NotReady 0
Idle 1
Connecting 2
Connected 3
Scanning 4
ApMode 5
StatusError 6
DriverRecovery 7
DriverFatal 8

DateFormatType

Name Value
Invalid 0
A 1
B 2
C 3
D 4
E 5
F 6
G 7

DayOfWeek

Name Value
Sunday 0
Monday 1
Tuesday 2
Wednesday 3
Thursday 4
Friday 5
Saturday 6

DebugTimeSkipMode

Name Value
Disabled 0
Moderate 1
Fast 2
SuperFast 3

DopplerBedKindType

Name Value
Invalid 0
Single 1
SemiDouble_Double 2
Queen_King 3

DopplerSensorSensitivityType

Name Value
Invalid 0
Low 1
Normal 2

FontHorizontalAlign

Name Value
Left 0
Center 1
Right 2

FontVerticalAlign

Name Value
Top 0
Center 1
Bottom 2
BottomOffset 3

IpConfigurationType

Name Value
Static 0
Dhcp 1

KeyIndex

Name Value
Enter 0
Left 1
Right 2

LanguageType

Name Value
en 0
fr 1
de 2
es 3
it 4
nl 5
pt 6
ja 7
tw 8
cn 9
ko 10
defaultLanguage 11

LayoutTextAlign

Name Value
Left 0
Center 1
Right 2

LocaleType

Name Value
JPja 0
EUen 1
EUfr 2
EUit 3
EUde 4
EUes 5
EUnl 6
USen 7
USpt 8
USfr 9
USes 10
KRko 11
CNzh 12
TWzh 13

LoopCommand

Name Value
Continue 1
Break 2
Name Value
MainMenu 0
Notification 1

NetworkControlState

Name Value
Disabled 0
Connecting 1
Idle 2
Connected 3
Disabling 4

NetworkSecurityType

Name Value
Invalid 0
Open 1
Wep 2
WpaPsk 3
Wpa2Psk 4
Wpa3Sae 5

NotificationHelpIndex

Name Value
Invalid -1
AlarmLeaveDirection 0
AlarmAbsenceFromStart 1
AlarmTimeout 2
BedtimeRecord 3
MorningRecord 4
RecordEnjoy1 5
RecordEnjoy2 6
MovementRecord 7

NotificationInternetType

Name Value
NewAlarm 0
FwUpdate 1
ServerEol 2
InternetConnection 3

NotificationTutorialIndex

Name Value
None 0
BedSound 1
TimeSignal 2
AlarmStandby 3
VolumeSetting 4
SimpleMode 5
ButtonMode 6
EnvironmentChecker 7
NetworkSetting 8
UserRecord 9
AlarmDayMode 10
InternetClockAdjust 11
MiddleMode 12
Last 12

NotificationType

Name Value
Invalid 0
Present 1
Internet 2
Tutorial 3
Help 4

RegionType

Name Value
JP 0
EU 2
AU 3
US 1
CN_TW_KR 4
defaultRegion 5

SceneSelectMode

Name Value
Fixed 0
SceneRandom 1
ThemeRandom 2

ScriptFlag

Name Value
NoInputTimeoutEnabled 0
SuppressAlarmTriggerFromMenu 1
AlarmTriggerWhenCompletedStateInOtaUpdate 2

SignalLevel

Name Value
SignalLevel_0 0
SignalLevel_1 1
SignalLevel_2 2
SignalLevel_3 3

SpriteDrawType

Name Value
Fill 0
Blend 1

TimeFormatType

Name Value
Invalid 0
H12 1
H24 2

TypeCCurrentType

Name Value
Unknown 0
NotTypeCPort 1
DefaultType 2
_1p5AType 3
_3p0AType 4

ViewportId

Name Value
Main 0
Overlay 1
Background 2
Foreground 3
Clock 4

VisualizeUserStateType

Name Value
Disappear 0
Appear 1
Exist 2
Leave 3

(More Coming Soon)

Work in progress

This page is currently under development.

Feel free to follow @KernelEquinox to get notified about site and documentation updates as they happen.