ORK Framework  2.27.1
API Documentation
ORKFramework.Menu.MenuScreen Class Reference
Inheritance diagram for ORKFramework.Menu.MenuScreen:
ORKFramework.BaseIndexData ORKFramework.IChoiceSimple ORKFramework.Events.IEventStarter ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

 MenuScreen (string name)
 
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
void Clear ()
 
bool IsFocused ()
 
bool CheckRequirements ()
 
void Tick ()
 
void ChangeActivePart (int change)
 
void AllClosedResetSelections ()
 
bool IsInventoryExchange ()
 
void ShowInventoryExchange (IEventStarter starter, IInventoryExchange inventory, IInventoryExchange inventory2)
 
void Show (IEventStarter starter)
 
void Show ()
 
void Show (bool fromOtherScreen)
 
void EditorClose ()
 
void CloseImmediate ()
 
void Close (MenuScreenItem call)
 
void Close ()
 
void CloseScreensOpening ()
 
void CloseScreensClosing ()
 
void ShowDescription (string desc, string name, IContentSimple content)
 
bool CombatantPartSelection (MenuScreenItem menuItem, BaseMenuPart menuOrigin)
 
void EventEnded ()
 
void DontDestroy ()
 
void OnSceneLoaded ()
 
- Public Member Functions inherited from ORKFramework.BaseData
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 

Public Attributes

string name = ""
 
bool rememberSelection = false
 
bool allClosedResetSelection = false
 
bool blockControl = true
 
bool blockControlMaps = true
 
bool pauseNotifications = false
 
bool singleScreen = true
 
bool closeOn2nd = true
 
bool close2ndFocused = false
 
bool closeFocusLost = false
 
bool pauseGame = false
 
bool pauseTime = false
 
bool freezePause = false
 
bool setTimeScale = false
 
bool setORKScale = false
 
float timeScale = 1
 
bool useKey = false
 
int keyID = 0
 
bool useReq = false
 
int reqID = 0
 
bool useCloseKey = false
 
int closeKeyID = 0
 
GUIBoxAudioType closeAudioType = GUIBoxAudioType.Cancel
 
bool closeKeyNoReturn = false
 
bool closeKeyAll = false
 
bool openMenuUser = false
 
bool aliveUser = false
 
bool noHiddenUser = false
 
bool battleGroupUser = false
 
bool allowNonPlayer = false
 
bool allowComChange = false
 
bool changeOnlyBattle = true
 
int prevKeyID = 0
 
int nextKeyID = 0
 
bool allowPartChange = false
 
int prevPartKeyID = 0
 
int nextPartKeyID = 0
 
bool noGeneralBG = false
 
bool ownBG = false
 
BackgroundImage [] background
 
AssetSource< AudioClip > openClip = new AssetSource<AudioClip>()
 
float openVolume = 1
 
AssetSource< AudioClip > closeClip = new AssetSource<AudioClip>()
 
float closeVolume = 1
 
AssetSource< AudioClip > failClip
 
float failVolume = 1
 
AssetSource< ORKGameEventopenGameEvent = new AssetSource<ORKGameEvent>()
 
bool openWaitForEvent = false
 
bool eventOnlyWhenOpening = false
 
AssetSource< ORKGameEventcloseGameEvent = new AssetSource<ORKGameEvent>()
 
bool closeWaitForEvent = false
 
bool closeEventAfterFading = true
 
bool eventOnlyWhenClosing = false
 
bool ownMusic = false
 
int musicStoreID = 1
 
PlayMusic playMusic
 
PlayMusicStored playStored
 
int [] closeScreensOpening
 
int [] closeScreensClosing
 
BaseMenuPart [] part = new BaseMenuPart[0]
 

Properties

MenuStatus Status [get]
 
Combatant Combatant [get, set]
 
bool RememberSelection [get]
 
GameObject GameObject [get]
 
- Properties inherited from ORKFramework.BaseIndexData
virtual int RealID [get, set]
 
- Properties inherited from ORKFramework.Events.IEventStarter
GameObject GameObject [get]
 

Additional Inherited Members

- Protected Attributes inherited from ORKFramework.BaseIndexData
int realID = 0
 

Member Function Documentation

◆ SetData()

override void ORKFramework.Menu.MenuScreen.SetData ( DataObject  data)
virtual

Sets the variables of the class using a ORKFramework.DataObject.

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.