Sonic Frontiers Script Functions: Difference between revisions
NextinHKRY (talk | contribs) Created page with "{{Notice|type=warn|content=This list is still a work in progress! Any additions and updates are greatly appreciated!}} Functions are listed below in the following format: Function(arguments, ...) : returnType == 🗒️ AchivementUnlock(string, number) == === Description === Unlocks an achievement. === Parameters === * (<ins>'''string'''</ins>, number): Name of the achievement to unlock * (string, <ins>'''..." |
NextinHKRY (talk | contribs) No edit summary |
||
| Line 4: | Line 4: | ||
Function(arguments, ...) : returnType | Function(arguments, ...) : returnType | ||
== | == AchivementUnlock(string, number) == | ||
=== Description === | === Description === | ||
| Line 14: | Line 14: | ||
* (string, <ins>'''number'''</ins>): ''Unknown...'' | * (string, <ins>'''number'''</ins>): ''Unknown...'' | ||
== | == ActivityComplete(number) : unknown == | ||
=== Description === | === Description === | ||
| Line 25: | Line 25: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == ActivityStart(number) : unknown == | ||
=== Description === | === Description === | ||
| Line 33: | Line 33: | ||
=== Return Value === | === Return Value === | ||
== | == ActivityTaskComplete(number, number) : unknown == | ||
=== Description === | === Description === | ||
| Line 41: | Line 41: | ||
=== Return Value === | === Return Value === | ||
== | == ActivityTaskEnd() : unknown == | ||
=== Description === | === Description === | ||
| Line 52: | Line 52: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == ActivityTaskStart(number, number) : unknown == | ||
=== Description === | === Description === | ||
| Line 60: | Line 60: | ||
=== Return Value === | === Return Value === | ||
== | == AddPracticeNotifierPermissionDeny(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 68: | Line 68: | ||
=== Return Value === | === Return Value === | ||
== | == AutoSave(string) == | ||
=== Description === | === Description === | ||
| Line 90: | Line 90: | ||
---- | ---- | ||
== | == BeginTalkMode(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 98: | Line 98: | ||
=== Return Value === | === Return Value === | ||
== | == ChangeEventCamera(string) == | ||
=== Description === | === Description === | ||
| Line 107: | Line 107: | ||
* (<ins>'''string'''</ins>): Camera name | * (<ins>'''string'''</ins>): Camera name | ||
== | == ChangeMotion(string) == | ||
=== Description === | === Description === | ||
| Line 138: | Line 138: | ||
---- | ---- | ||
== | == ChangePlayerAnimInHold(string, number) : yield == | ||
=== Description === | === Description === | ||
| Line 148: | Line 148: | ||
* (string, <ins>'''number'''</ins>): Duration (seconds) | * (string, <ins>'''number'''</ins>): Duration (seconds) | ||
== | == ChangePlayerMotion(string, number) : yield == | ||
=== Description === | === Description === | ||
| Line 158: | Line 158: | ||
* (string, <ins>'''number'''</ins>): Duration (seconds) | * (string, <ins>'''number'''</ins>): Duration (seconds) | ||
== | == ChangeSavePermission(string) == | ||
=== Description === | === Description === | ||
| Line 177: | Line 177: | ||
---- | ---- | ||
== | == ChangeWeather(number, string) == | ||
=== Description === | === Description === | ||
| Line 201: | Line 201: | ||
---- | ---- | ||
== | == ClearIsland() == | ||
=== Description === | === Description === | ||
Sets the cleared state of the current island and proceeds to the next. | Sets the cleared state of the current island and proceeds to the next. | ||
== | == ClearObjectTarget() : unknown == | ||
=== Description === | === Description === | ||
| Line 214: | Line 214: | ||
=== Return Value === | === Return Value === | ||
== | == ClearPracticeNotifier() : yield == | ||
=== Description === | === Description === | ||
Clears the Training Simulator notification on the top-right of the heads-up display. | Clears the Training Simulator notification on the top-right of the heads-up display. | ||
== | == ClearQuestTarget() : unknown == | ||
=== Description === | === Description === | ||
| Line 227: | Line 227: | ||
=== Return Value === | === Return Value === | ||
== | == ClearTutorialUI(boolean) : unknown == | ||
=== Description === | === Description === | ||
| Line 235: | Line 235: | ||
=== Return Value === | === Return Value === | ||
== | == ClearUserGuidUI() : yield == | ||
=== Description === | === Description === | ||
Clears an input guide. | Clears an input guide. | ||
== | == DebugPrint() : number == | ||
=== Description === | === Description === | ||
| Line 251: | Line 251: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == DeletePracticeNotifierPermissionDeny(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 259: | Line 259: | ||
=== Return Value === | === Return Value === | ||
== | == EndLetterBoxUI() : unknown == | ||
=== Description === | === Description === | ||
| Line 270: | Line 270: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == EndTalkMode() : unknown == | ||
=== Description === | === Description === | ||
| Line 278: | Line 278: | ||
=== Return Value === | === Return Value === | ||
== | == EndTimeGimmick() : unknown == | ||
=== Description === | === Description === | ||
| Line 286: | Line 286: | ||
=== Return Value === | === Return Value === | ||
== | == Exit() == | ||
=== Description === | === Description === | ||
Ends the current script sequence. | Ends the current script sequence. | ||
== | == FadeIn(number) == | ||
=== Description === | === Description === | ||
| Line 300: | Line 300: | ||
* (<ins>'''number'''</ins>): Duration (seconds) (optional) | * (<ins>'''number'''</ins>): Duration (seconds) (optional) | ||
== | == FadeOut(number, string) : yield == | ||
=== Description === | === Description === | ||
| Line 320: | Line 320: | ||
---- | ---- | ||
== | == GetBlock() : number == | ||
=== Description === | === Description === | ||
| Line 328: | Line 328: | ||
The current block ID. | The current block ID. | ||
== | == GetChaosEmerald(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 336: | Line 336: | ||
=== Return Value === | === Return Value === | ||
== | == GetChaosEmeraldNum() : number == | ||
=== Description === | === Description === | ||
| Line 344: | Line 344: | ||
The total number of Chaos Emeralds. | The total number of Chaos Emeralds. | ||
== | == GetClearTowerNum() : unknown == | ||
=== Description === | === Description === | ||
| Line 352: | Line 352: | ||
=== Return Value === | === Return Value === | ||
== | == GetDebugFlag(string) : number == | ||
=== Description === | === Description === | ||
| Line 372: | Line 372: | ||
The value of the requested flag. | The value of the requested flag. | ||
== | == GetGuardLevel(number) : number == | ||
=== Description === | === Description === | ||
| Line 380: | Line 380: | ||
=== Return Value === | === Return Value === | ||
== | == GetHackingAliveEnemyNum() : unknown == | ||
=== Description === | === Description === | ||
| Line 391: | Line 391: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == GetHackingCurrentWaveId() : unknown == | ||
=== Description === | === Description === | ||
| Line 399: | Line 399: | ||
=== Return Value === | === Return Value === | ||
== | == GetHasChaosEmeraldNum() : number == | ||
=== Description === | === Description === | ||
| Line 407: | Line 407: | ||
The total number of currently obtained Chaos Emeralds. | The total number of currently obtained Chaos Emeralds. | ||
== | == GetMaxGuardLevel() : number == | ||
=== Description === | === Description === | ||
| Line 415: | Line 415: | ||
=== Return Value === | === Return Value === | ||
== | == GetMaxPowerLevel(number) : number == | ||
=== Description === | === Description === | ||
| Line 423: | Line 423: | ||
=== Return Value === | === Return Value === | ||
== | == GetMaxRingLevel() : number == | ||
=== Description === | === Description === | ||
| Line 431: | Line 431: | ||
=== Return Value === | === Return Value === | ||
== | == GetMaxSpeedLevel() : number == | ||
=== Description === | === Description === | ||
| Line 439: | Line 439: | ||
=== Return Value === | === Return Value === | ||
== | == GetMinigameQuestProgress(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 447: | Line 447: | ||
=== Return Value === | === Return Value === | ||
== | == GetObjStatus(string, number, number) : boolean == | ||
=== Description === | === Description === | ||
| Line 455: | Line 455: | ||
=== Return Value === | === Return Value === | ||
== | == GetPinballStatus(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 463: | Line 463: | ||
=== Return Value === | === Return Value === | ||
== | == GetPlayerItemInfo(string) : number == | ||
=== Description === | === Description === | ||
| Line 471: | Line 471: | ||
=== Return Value === | === Return Value === | ||
== | == GetPlayerStatus(string) : number == | ||
=== Description === | === Description === | ||
| Line 496: | Line 496: | ||
A 0/1 number representing the requested state. | A 0/1 number representing the requested state. | ||
== | == GetPowerLevel(number) : number == | ||
=== Description === | === Description === | ||
| Line 504: | Line 504: | ||
=== Return Value === | === Return Value === | ||
== | == GetPowerupRequiredKodamaNum() : unknown == | ||
=== Description === | === Description === | ||
| Line 515: | Line 515: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == GetRingLevel(number) : number == | ||
=== Description === | === Description === | ||
| Line 523: | Line 523: | ||
=== Return Value === | === Return Value === | ||
== | == GetSelectResult(number) : number == | ||
=== Description === | === Description === | ||
| Line 531: | Line 531: | ||
=== Return Value === | === Return Value === | ||
== | == GetSpeedLevel(number) : number == | ||
=== Description === | === Description === | ||
| Line 539: | Line 539: | ||
=== Return Value === | === Return Value === | ||
== | == GetValue(string, number) : number == | ||
=== Description === | === Description === | ||
| Line 552: | Line 552: | ||
The value of the requested flag. | The value of the requested flag. | ||
== | == GiantOrbReleaseTemporarilyReset() : unknown == | ||
=== Description === | === Description === | ||
| Line 560: | Line 560: | ||
=== Return Value === | === Return Value === | ||
== | == GiantOrbTemporarilyReset() : unknown == | ||
=== Description === | === Description === | ||
| Line 568: | Line 568: | ||
=== Return Value === | === Return Value === | ||
== | == GoToCyberStage(string) : yield == | ||
=== Description === | === Description === | ||
| Line 576: | Line 576: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == HideObjectInEvent(string) == | ||
=== Description === | === Description === | ||
| Line 585: | Line 585: | ||
* (<ins>'''string'''</ins>): Object name | * (<ins>'''string'''</ins>): Object name | ||
== | == HoldPlayer() == | ||
=== Description === | === Description === | ||
Disables player movement. | Disables player movement. | ||
== | == IsAvailableKodamaElderLvUp() : boolean == | ||
=== Description === | === Description === | ||
| Line 598: | Line 598: | ||
=== Return Value === | === Return Value === | ||
== | == IsHackingCurrentWaveIdInRange(number, number) : unknown == | ||
=== Description === | === Description === | ||
| Line 606: | Line 606: | ||
=== Return Value === | === Return Value === | ||
== | == IsInScreenView(string, number, number) : boolean == | ||
=== Description === | === Description === | ||
| Line 614: | Line 614: | ||
=== Return Value === | === Return Value === | ||
== | == IsLoadingLevel() : number == | ||
=== Description === | === Description === | ||
| Line 622: | Line 622: | ||
A 0/1 number representing if a level is being loaded. | A 0/1 number representing if a level is being loaded. | ||
== | == IsPlayingDiEvent(string) : number == | ||
=== Description === | === Description === | ||
| Line 634: | Line 634: | ||
A 0/1 number representing if the specified event is currently playing. | A 0/1 number representing if the specified event is currently playing. | ||
== | == IsPlayingDiEventAll() : number == | ||
=== Description === | === Description === | ||
| Line 642: | Line 642: | ||
A 0/1 number representing if any event is playing. | A 0/1 number representing if any event is playing. | ||
== | == IsPlayingQuest() : unknown == | ||
=== Description === | === Description === | ||
| Line 650: | Line 650: | ||
=== Return Value === | === Return Value === | ||
== | == KillPinballObjects() : unknown == | ||
=== Description === | === Description === | ||
| Line 658: | Line 658: | ||
=== Return Value === | === Return Value === | ||
== | == LoadDiEvent(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 666: | Line 666: | ||
=== Return Value === | === Return Value === | ||
== | == LoadDiEventFrozen(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 674: | Line 674: | ||
=== Return Value === | === Return Value === | ||
== | == LoadLevel(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 683: | Line 683: | ||
* (<ins>'''string'''</ins>): Level name | * (<ins>'''string'''</ins>): Level name | ||
== | == MakeElectricLine(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 691: | Line 691: | ||
=== Return Value === | === Return Value === | ||
== | == MovedPlayer(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 699: | Line 699: | ||
=== Return Value === | === Return Value === | ||
== | == NextBlock(number) : unknown == | ||
=== Description === | === Description === | ||
| Line 707: | Line 707: | ||
=== Return Value === | === Return Value === | ||
== | == NextSequence(number) == | ||
=== Description === | === Description === | ||
| Line 716: | Line 716: | ||
* (<ins>'''number'''</ins>): Sequence ID | * (<ins>'''number'''</ins>): Sequence ID | ||
== | == NotifyAction(string, string) == | ||
=== Description === | === Description === | ||
| Line 742: | Line 742: | ||
---- | ---- | ||
== | == PlayDiEvent(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 750: | Line 750: | ||
=== Return Value === | === Return Value === | ||
== | == PlayDiEventFrozen(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 758: | Line 758: | ||
=== Return Value === | === Return Value === | ||
== | == PlayerGetItem(string, number) == | ||
=== Description === | === Description === | ||
| Line 778: | Line 778: | ||
---- | ---- | ||
== | == PlayerNonOperation() : yield == | ||
=== Description === | === Description === | ||
Disables player movement. | Disables player movement. | ||
== | == PlayVoice(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 791: | Line 791: | ||
=== Return Value === | === Return Value === | ||
== | == QuitMinigameQuest() : unknown == | ||
=== Description === | === Description === | ||
| Line 799: | Line 799: | ||
=== Return Value === | === Return Value === | ||
== | == ReleaseHoldPlayer() == | ||
=== Description === | === Description === | ||
Enables player movement. | Enables player movement. | ||
== | == ReleasePresentSkill(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 812: | Line 812: | ||
=== Return Value === | === Return Value === | ||
== | == ResetCamera() == | ||
=== Description === | === Description === | ||
Restores the player-operated camera. | Restores the player-operated camera. | ||
== | == ResetMenuDisabledMinigameQuest() : unknown == | ||
=== Description === | === Description === | ||
| Line 825: | Line 825: | ||
=== Return Value === | === Return Value === | ||
== | == ResetPinball() : unknown == | ||
=== Description === | === Description === | ||
| Line 833: | Line 833: | ||
=== Return Value === | === Return Value === | ||
== | == ResetWeather(number) : unknown == | ||
=== Description === | === Description === | ||
| Line 841: | Line 841: | ||
=== Return Value === | === Return Value === | ||
== | == Save() : yield == | ||
=== Description === | === Description === | ||
| Line 847: | Line 847: | ||
=== Parameters === | === Parameters === | ||
== | == SetBossKnightLayerEnabled(boolean) : unknown == | ||
=== Description === | === Description === | ||
| Line 855: | Line 855: | ||
=== Return Value === | === Return Value === | ||
== | == SetHackingBulletPatternGlobalVelTimes(number) : unknown == | ||
=== Description === | === Description === | ||
| Line 863: | Line 863: | ||
=== Return Value === | === Return Value === | ||
== | == SetHackingBulletPatternVelRange(number, number) : unknown == | ||
=== Description === | === Description === | ||
| Line 871: | Line 871: | ||
=== Return Value === | === Return Value === | ||
== | == SetHUDEnabled(string, boolean) == | ||
=== Description === | === Description === | ||
| Line 895: | Line 895: | ||
* (string, <ins>'''boolean'''</ins>): Enabled | * (string, <ins>'''boolean'''</ins>): Enabled | ||
== | == SetLayerEnabled(string, boolean) == | ||
=== Description === | === Description === | ||
| Line 905: | Line 905: | ||
* (string, <ins>'''boolean'''</ins>): Enabled | * (string, <ins>'''boolean'''</ins>): Enabled | ||
== | == SetLayerEnabledInEvent(string, boolean) == | ||
=== Description === | === Description === | ||
| Line 915: | Line 915: | ||
* (string, <ins>'''boolean'''</ins>): Enabled | * (string, <ins>'''boolean'''</ins>): Enabled | ||
== | == SetLookAt(number, number, number) == | ||
=== Description === | === Description === | ||
| Line 926: | Line 926: | ||
* (number, number, <ins>'''number'''</ins>): Z | * (number, number, <ins>'''number'''</ins>): Z | ||
== | == SetMenuDisabledMinigameQuest(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 934: | Line 934: | ||
=== Return Value === | === Return Value === | ||
== | == SetObjStatus(string, number, number) : unknown == | ||
=== Description === | === Description === | ||
| Line 942: | Line 942: | ||
=== Return Value === | === Return Value === | ||
== | == SetPlayerAbilityEnabled(string, boolean) == | ||
=== Description === | === Description === | ||
| Line 987: | Line 987: | ||
* (string, <ins>'''boolean'''</ins>): Value | * (string, <ins>'''boolean'''</ins>): Value | ||
== | == SetTime(number, number) == | ||
=== Description === | === Description === | ||
| Line 997: | Line 997: | ||
* (number, <ins>'''number'''</ins>): Minute | * (number, <ins>'''number'''</ins>): Minute | ||
== | == SetTimePause(boolean) == | ||
=== Description === | === Description === | ||
| Line 1,006: | Line 1,006: | ||
* (<ins>'''boolean'''</ins>): Enabled | * (<ins>'''boolean'''</ins>): Enabled | ||
== | == SetValue(string, number, number) == | ||
=== Description === | === Description === | ||
| Line 1,017: | Line 1,017: | ||
* (string, number, <ins>'''number'''</ins>): Value | * (string, number, <ins>'''number'''</ins>): Value | ||
== | == SetVisibleKodama(string) == | ||
=== Description === | === Description === | ||
| Line 1,036: | Line 1,036: | ||
---- | ---- | ||
== | == ShootBulletPattern(string) == | ||
=== Description === | === Description === | ||
| Line 1,045: | Line 1,045: | ||
* (<ins>'''string'''</ins>): Pattern name | * (<ins>'''string'''</ins>): Pattern name | ||
== | == ShowHeaderWindowUI(string, string) == | ||
=== Description === | === Description === | ||
| Line 1,055: | Line 1,055: | ||
* (string, <ins>'''string'''</ins>): Body name | * (string, <ins>'''string'''</ins>): Body name | ||
== | == ShowObjectTarget(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 1,063: | Line 1,063: | ||
=== Return Value === | === Return Value === | ||
== | == ShowPracticeNotifier(number, number, number) : unknown == | ||
=== Description === | === Description === | ||
| Line 1,071: | Line 1,071: | ||
=== Return Value === | === Return Value === | ||
== | == ShowQuestTarget(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 1,079: | Line 1,079: | ||
=== Return Value === | === Return Value === | ||
== | == ShowRobberTargetUI() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,087: | Line 1,087: | ||
=== Return Value === | === Return Value === | ||
== | == ShowSelectBox(string, string, string, string) : unknown == | ||
=== Description === | === Description === | ||
| Line 1,095: | Line 1,095: | ||
=== Return Value === | === Return Value === | ||
== | == ShowSelectBoxNoWaitVoice(string, string, string, string, string) : unknown == | ||
=== Description === | === Description === | ||
| Line 1,103: | Line 1,103: | ||
=== Return Value === | === Return Value === | ||
== | == ShowSequenceUI(string) == | ||
=== Description === | === Description === | ||
| Line 1,131: | Line 1,131: | ||
---- | ---- | ||
== | == ShowTalkCaption(string) == | ||
=== Description === | === Description === | ||
| Line 1,137: | Line 1,137: | ||
=== Parameters === | === Parameters === | ||
== | == ShowTalkCaptionOverFade(string) : yield == | ||
=== Description === | === Description === | ||
| Line 1,148: | Line 1,148: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == ShowToastUI(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 1,156: | Line 1,156: | ||
=== Return Value === | === Return Value === | ||
== | == ShowTutorialUI(string, string) : unknown == | ||
=== Description === | === Description === | ||
| Line 1,164: | Line 1,164: | ||
=== Return Value === | === Return Value === | ||
== | == ShowUserGuidUI(string) == | ||
=== Description === | === Description === | ||
| Line 1,270: | Line 1,270: | ||
---- | ---- | ||
== | == ShowYesNoWindowUI(string, string) : yield == | ||
=== Description === | === Description === | ||
| Line 1,280: | Line 1,280: | ||
* (string, <ins>'''string'''</ins>): Body name | * (string, <ins>'''string'''</ins>): Body name | ||
== | == SpawnHackingEnemy(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 1,288: | Line 1,288: | ||
=== Return Value === | === Return Value === | ||
== | == SpawnPinballObjects() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,296: | Line 1,296: | ||
=== Return Value === | === Return Value === | ||
== | == SpawnPinballObjectsAfterClearing() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,304: | Line 1,304: | ||
=== Return Value === | === Return Value === | ||
== | == StartClearCheck() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,312: | Line 1,312: | ||
=== Return Value === | === Return Value === | ||
== | == StartLetterBoxUI() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,323: | Line 1,323: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == StartMinigameQuest(string) : unknown == | ||
=== Description === | === Description === | ||
| Line 1,331: | Line 1,331: | ||
=== Return Value === | === Return Value === | ||
== | == StartPinball() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,339: | Line 1,339: | ||
=== Return Value === | === Return Value === | ||
== | == StartTimeGimmick() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,347: | Line 1,347: | ||
=== Return Value === | === Return Value === | ||
== | == StartupGimmickInfo() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,358: | Line 1,358: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == StartWaitMinigameQuest() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,366: | Line 1,366: | ||
=== Return Value === | === Return Value === | ||
== | == UnloadDiEvent() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,377: | Line 1,377: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == UnloadLevel() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,388: | Line 1,388: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == WaitFromChaosEmeraldNum() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,399: | Line 1,399: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == WaitFromFlag() : unknown == | ||
=== Description === | === Description === | ||
| Line 1,410: | Line 1,410: | ||
''Unknown...'' | ''Unknown...'' | ||
== | == WaitTime(number) == | ||
=== Description === | === Description === | ||
Latest revision as of 13:47, 15 February 2025
Warning
This list is still a work in progress! Any additions and updates are greatly appreciated!
Functions are listed below in the following format:
Function(arguments, ...) : returnType
AchivementUnlock(string, number)
Description
Unlocks an achievement.
Parameters
- (string, number): Name of the achievement to unlock
- (string, number): Unknown...
ActivityComplete(number) : unknown
Description
This function has no callback function.
Parameters
Unknown...
Return Value
Unknown...
ActivityStart(number) : unknown
Description
Parameters
Return Value
ActivityTaskComplete(number, number) : unknown
Description
Parameters
Return Value
ActivityTaskEnd() : unknown
Description
This function is unused and has no callback function.
Parameters
Unknown...
Return Value
Unknown...
ActivityTaskStart(number, number) : unknown
Description
Parameters
Return Value
AddPracticeNotifierPermissionDeny(string) : unknown
Description
Parameters
Return Value
AutoSave(string)
Description
Saves the current game data into the autosave slot.
Parameters
- (string): Save mode
| Mode | Description |
|---|---|
| forceimmediate | The most common and seemingly default save mode. |
| immediate | Unknown... |
BeginTalkMode(string) : unknown
Description
Parameters
Return Value
ChangeEventCamera(string)
Description
Change to an event camera.
Parameters
- (string): Camera name
ChangeMotion(string)
Description
Changes animations for dialogue events.
Parameters
- (string): Animation name
| Name |
|---|
| happy |
| no |
| rod |
| take |
| talk |
| talk_start |
| think |
| yes |
ChangePlayerAnimInHold(string, number) : yield
Description
Plays an animation from an *.asm file using the friendly (upper-case) name when the player is frozen using HoldPlayer().
Parameters
- (string, string): Animation name
- (string, number): Duration (seconds)
ChangePlayerMotion(string, number) : yield
Description
Plays an animation from an *.asm file using the friendly (upper-case) name where available.
Parameters
- (string, string): Animation name
- (string, number): Duration (seconds)
ChangeSavePermission(string)
Description
Toggles whether the player has permission to save.
Parameters
- (string): Permission state
| State |
|---|
| allow |
| deny |
ChangeWeather(number, string)
Description
Changes the current weather.
Parameters
- (number, string): Unknown...
- (number, string): Weather name
| Name |
|---|
| Cloudy |
| Rainy |
| SandStorm |
| Sunny |
ClearIsland()
Description
Sets the cleared state of the current island and proceeds to the next.
ClearObjectTarget() : unknown
Description
Parameters
Return Value
ClearPracticeNotifier() : yield
Description
Clears the Training Simulator notification on the top-right of the heads-up display.
ClearQuestTarget() : unknown
Description
Parameters
Return Value
ClearTutorialUI(boolean) : unknown
Description
Parameters
Return Value
ClearUserGuidUI() : yield
Description
Clears an input guide.
DebugPrint() : number
Description
This function is unused and has a stripped callback function.
Parameters
Unknown...
Return Value
Unknown...
DeletePracticeNotifierPermissionDeny(string) : unknown
Description
Parameters
Return Value
EndLetterBoxUI() : unknown
Description
This function is unused.
Parameters
Unknown...
Return Value
Unknown...
EndTalkMode() : unknown
Description
Parameters
Return Value
EndTimeGimmick() : unknown
Description
Parameters
Return Value
Exit()
Description
Ends the current script sequence.
FadeIn(number)
Description
Fades the screen into gameplay from black within the specified duration.
Parameters
- (number): Duration (seconds) (optional)
FadeOut(number, string) : yield
Description
Fades the screen out within the specified duration.
Parameters
- (number, string): Duration (seconds) (optional)
- (number, string): Colour type (optional)
| Colours |
|---|
| black (default) |
| white |
GetBlock() : number
Description
Gets the current internal block ID for Lua conditions within update functions.
Return Value
The current block ID.
GetChaosEmerald(string) : unknown
Description
Parameters
Return Value
GetChaosEmeraldNum() : number
Description
Gets the total number of Chaos Emeralds.
Return Value
The total number of Chaos Emeralds.
GetClearTowerNum() : unknown
Description
Parameters
Return Value
GetDebugFlag(string) : number
Description
Gets the value of any flag Sonic Team wants to check within Lua scripts.
Parameters
- (string): Flag name
| Name |
|---|
| isTutorialEnable |
Return Value
The value of the requested flag.
GetGuardLevel(number) : number
Description
Parameters
Return Value
GetHackingAliveEnemyNum() : unknown
Description
This function is unused.
Parameters
Unknown...
Return Value
Unknown...
GetHackingCurrentWaveId() : unknown
Description
Parameters
Return Value
GetHasChaosEmeraldNum() : number
Description
Gets the total number of currently obtained Chaos Emeralds.
Return Value
The total number of currently obtained Chaos Emeralds.
GetMaxGuardLevel() : number
Description
Parameters
Return Value
GetMaxPowerLevel(number) : number
Description
Parameters
Return Value
GetMaxRingLevel() : number
Description
Parameters
Return Value
GetMaxSpeedLevel() : number
Description
Parameters
Return Value
GetMinigameQuestProgress(string) : unknown
Description
Parameters
Return Value
GetObjStatus(string, number, number) : boolean
Description
Parameters
Return Value
GetPinballStatus(string) : unknown
Description
Parameters
Return Value
GetPlayerItemInfo(string) : number
Description
Parameters
Return Value
GetPlayerStatus(string) : number
Description
Returns the value of status flags for the player.
Parameters
- (string): Flag name
| Name | Description |
|---|---|
| Hold | Checks if the player is frozen via HoldPlayer() |
| OnGround | Checks if the player is grounded |
Return Value
A 0/1 number representing the requested state.
GetPowerLevel(number) : number
Description
Parameters
Return Value
GetPowerupRequiredKodamaNum() : unknown
Description
This function is unused.
Parameters
Unknown...
Return Value
Unknown...
GetRingLevel(number) : number
Description
Parameters
Return Value
GetSelectResult(number) : number
Description
Parameters
Return Value
GetSpeedLevel(number) : number
Description
Parameters
Return Value
GetValue(string, number) : number
Description
Get the value of a flag based on the flag name and flag number.
Parameters
- (string, number): Flag name
- (string, number): Flag number
Return Value
The value of the requested flag.
GiantOrbReleaseTemporarilyReset() : unknown
Description
Parameters
Return Value
GiantOrbTemporarilyReset() : unknown
Description
Parameters
Return Value
GoToCyberStage(string) : yield
Description
This function is unused.
Parameters
Unknown...
HideObjectInEvent(string)
Description
Hides the specified object during an event.
Parameters
- (string): Object name
HoldPlayer()
Description
Disables player movement.
IsAvailableKodamaElderLvUp() : boolean
Description
Parameters
Return Value
IsHackingCurrentWaveIdInRange(number, number) : unknown
Description
Parameters
Return Value
IsInScreenView(string, number, number) : boolean
Description
Parameters
Return Value
IsLoadingLevel() : number
Description
Returns whether a level is actively being loaded via the LoadLevel() function for pausing the script until it's finished.
Return Value
A 0/1 number representing if a level is being loaded.
IsPlayingDiEvent(string) : number
Description
Returns whether the specified event is currently playing.
Parameters
- (string): Event name
Return Value
A 0/1 number representing if the specified event is currently playing.
IsPlayingDiEventAll() : number
Description
Returns whether any event is playing.
Return Value
A 0/1 number representing if any event is playing.
IsPlayingQuest() : unknown
Description
Parameters
Return Value
KillPinballObjects() : unknown
Description
Parameters
Return Value
LoadDiEvent(string) : unknown
Description
Parameters
Return Value
LoadDiEventFrozen(string) : unknown
Description
Parameters
Return Value
LoadLevel(string) : unknown
Description
Loads an archive (*.pac) using its respective *.level file.
Parameters
- (string): Level name
MakeElectricLine(string) : unknown
Description
Parameters
Return Value
MovedPlayer(string) : unknown
Description
Parameters
Return Value
NextBlock(number) : unknown
Description
Parameters
Return Value
NextSequence(number)
Description
Exits the current script sequence and loads the next one via the input ID.
Parameters
- (number): Sequence ID
NotifyAction(string, string)
Description
Sends a message to the specified object in the *.gedit files. Typically used to turn camera volumes on or off.
Parameters
- (string, string): Internal name of the object to signal.
- (string, string): Message to send to the object.
| Name | Description |
|---|---|
| on | Activates the object. |
| off | Deactivates the object. |
| start | Unknown... |
PlayDiEvent(string) : unknown
Description
Parameters
Return Value
PlayDiEventFrozen(string) : unknown
Description
Parameters
Return Value
PlayerGetItem(string, number)
Description
Gives the player a specific number of specific items.
Parameters
- (string, number): Item name
- (string, number): Item count
| Name |
|---|
| Ring |
| ExpPoint |
PlayerNonOperation() : yield
Description
Disables player movement.
PlayVoice(string) : unknown
Description
Parameters
Return Value
QuitMinigameQuest() : unknown
Description
Parameters
Return Value
ReleaseHoldPlayer()
Description
Enables player movement.
ReleasePresentSkill(string) : unknown
Description
Parameters
Return Value
ResetCamera()
Description
Restores the player-operated camera.
ResetMenuDisabledMinigameQuest() : unknown
Description
Parameters
Return Value
ResetPinball() : unknown
Description
Parameters
Return Value
ResetWeather(number) : unknown
Description
Parameters
Return Value
Save() : yield
Description
Parameters
SetBossKnightLayerEnabled(boolean) : unknown
Description
Parameters
Return Value
SetHackingBulletPatternGlobalVelTimes(number) : unknown
Description
Parameters
Return Value
SetHackingBulletPatternVelRange(number, number) : unknown
Description
Parameters
Return Value
SetHUDEnabled(string, boolean)
Description
Toggles whether certain menus are available to the player.
Parameters
- (string, boolean): Menu name
| Name | Description |
|---|---|
| MainMenu | Toggles access to the pause menu. |
| MapMenu | Toggles access to the map screen. |
- (string, boolean): Enabled
SetLayerEnabled(string, boolean)
Description
Toggles whether an object layout layer is visible.
Parameters
- (string, boolean): Layer name
- (string, boolean): Enabled
SetLayerEnabledInEvent(string, boolean)
Description
Toggles whether an object layout layer is visible during an event.
Parameters
- (string, boolean): Layer name
- (string, boolean): Enabled
SetLookAt(number, number, number)
Description
Forces the camera to always look towards the specified position.
Parameters
- (number, number, number): X
- (number, number, number): Y
- (number, number, number): Z
SetMenuDisabledMinigameQuest(string) : unknown
Description
Parameters
Return Value
SetObjStatus(string, number, number) : unknown
Description
Parameters
Return Value
SetPlayerAbilityEnabled(string, boolean)
Description
Toggles whether the specified ability can be used by the player.
Parameters
- (string, boolean): Ability name
| Name | Description |
|---|---|
| Boost | Toggles the ability to boost. |
| ComboAttack | Toggles the ability to perform combo attacks. |
| ControlCamera | Toggles the ability to move the camera. |
| Cyloop | Toggles the ability to perform Cyloop. |
| HomingAttack | Toggles the ability to homing attack. |
| Jump | Toggles the ability to jump. |
| Lockon | Toggles the ability to lock onto enemies. |
| Parry | Toggles the ability to parry. |
| WallAction | Toggles the ability to climb walls. |
- (string, boolean): Value
SetTime(number, number)
Description
Sets the current time.
Parameters
- (number, number): Hour
- (number, number): Minute
SetTimePause(boolean)
Description
Toggles the passage of time.
Parameters
- (boolean): Enabled
SetValue(string, number, number)
Description
Sets a value for the specified flag.
Parameters
- (string, number, number): Flag name
- (string, number, number): Flag number
- (string, number, number): Value
SetVisibleKodama(string)
Description
This function does not work.
Parameters
- (string): Visibility state
| States |
|---|
| hide |
| show |
ShootBulletPattern(string)
Description
Shoots a pre-defined pattern of bullets for the Hacking minigame.
Parameters
- (string): Pattern name
ShowHeaderWindowUI(string, string)
Description
Displays a dialog using a caption and body entry from a *.cnvrs-text file.
Parameters
- (string, string): Caption name
- (string, string): Body name
ShowObjectTarget(string) : unknown
Description
Parameters
Return Value
ShowPracticeNotifier(number, number, number) : unknown
Description
Parameters
Return Value
ShowQuestTarget(string) : unknown
Description
Parameters
Return Value
ShowRobberTargetUI() : unknown
Description
Parameters
Return Value
ShowSelectBox(string, string, string, string) : unknown
Description
Parameters
Return Value
ShowSelectBoxNoWaitVoice(string, string, string, string, string) : unknown
Description
Parameters
Return Value
ShowSequenceUI(string)
Description
Displays a menu depending on the current sequence.
Parameters
- (string): Menu name
| Name | Description |
|---|---|
| MainMenu | Unknown... |
| MainMenu_ForTutorial | Displays the pause menu for highlighting the Cyloop skill. |
| MapMenu | Unknown... |
| PauseMenu | Unknown... |
ShowTalkCaption(string)
Description
Parameters
ShowTalkCaptionOverFade(string) : yield
Description
This function is unused.
Parameters
Unknown...
Return Value
Unknown...
ShowToastUI(string) : unknown
Description
Parameters
Return Value
ShowTutorialUI(string, string) : unknown
Description
Parameters
Return Value
ShowUserGuidUI(string)
Description
Displays an input guide for the specified control method.
Parameters
- (string): Name
Notice
Only three of these are actually used, as Sonic Team moved to using internal methods for displaying these guides, rather than using Lua.
Some names are unknown as they use string hashes that have no source yet.
| Name | Internal ID | Description |
|---|---|---|
| CameraControl | 0 | Displays a graphic for the right stick with the text "Camera". |
| Unknown... | 1 | Displays a quad direction graphic with no text. |
| Jump (unused) | 2 | Displays a graphic for the A button with no text. |
| Boost (unused) | 3 | Displays a graphic for the right trigger with no text. |
| HomingAttack | 4 | Displays a graphic for the X button with the text "Homing Attack". |
| Lockon (unused) | 5 | Displays a graphic for the right stick button with the text "Lock On". |
| Cyloop (unused) | 6 | Displays a graphic for the Y button with the text "Cyloop (while moving)". |
| CyloopBattle | 7 | Displays a graphic for the Y button with the text "Cyloop (while moving)". |
| Unknown... | 8 | Displays a graphic for the left bumper with no text. |
| WallRun (unused) | 9 | Displays two graphics, one with a quad direction graphic with the text "Climb", and another with a graphic for the right trigger with the text "Wall Run (while climbing)". |
| Boarding (unused) | 10 | Displays two graphics, one with a quad direction graphic with the text "Climb", and another with a graphic for the A button with no text. |
| Unknown... | 11 | Displays two graphics, one with a left/right direction graphic with no text, and another with a graphic for the left trigger with no text. |
| Diving (unused) | 12 | Displays a graphic for the right trigger with no text. |
| Unknown... | 13 | Displays two graphics, one with a quad direction graphic with the text "Move the target", and another with a graphic for the A button with the text "Cast the line". |
| Unknown... | 14 | Displays a graphic for the B button with the text "Quit". |
| Unknown... | 15 | Displays a graphic for the A button with the text "Reel it in". |
| Unknown... | 16 | Displays a graphic for the A button with the text "Hook the fish". |
| Unknown... | 17 | Displays a graphic for the A button with no text. |
| Unknown... | 18 | Displays a graphic for the A button with no text. |
| Unknown... | 19 | Displays a graphic for the X button with the text "Place cannonball". |
| Unknown... | 20 | Displays a graphic for the X button with the text "Load cannon". |
ShowYesNoWindowUI(string, string) : yield
Description
Displays a Yes/No dialog using a caption and body entry from a *.cnvrs-text file.
Parameters
- (string, string): Caption name
- (string, string): Body name
SpawnHackingEnemy(string) : unknown
Description
Parameters
Return Value
SpawnPinballObjects() : unknown
Description
Parameters
Return Value
SpawnPinballObjectsAfterClearing() : unknown
Description
Parameters
Return Value
StartClearCheck() : unknown
Description
Parameters
Return Value
StartLetterBoxUI() : unknown
Description
This function is unused.
Parameters
Unknown...
Return Value
Unknown...
StartMinigameQuest(string) : unknown
Description
Parameters
Return Value
StartPinball() : unknown
Description
Parameters
Return Value
StartTimeGimmick() : unknown
Description
Parameters
Return Value
StartupGimmickInfo() : unknown
Description
This function is unused.
Parameters
Unknown...
Return Value
Unknown...
StartWaitMinigameQuest() : unknown
Description
Parameters
Return Value
UnloadDiEvent() : unknown
Description
This function is unused.
Parameters
Unknown...
Return Value
Unknown...
UnloadLevel() : unknown
Description
This function is unused.
Parameters
Unknown...
Return Value
Unknown...
WaitFromChaosEmeraldNum() : unknown
Description
This function is unused.
Parameters
Unknown...
Return Value
Unknown...
WaitFromFlag() : unknown
Description
This function is unused.
Parameters
Unknown...
Return Value
Unknown...
WaitTime(number)
Description
Waits for a specified amount of time (in seconds).
Parameters
- (number): Seconds