ORK Framework  2.29.3
API Documentation
ORKFramework.Events.BaseEvent Class Referenceabstract
Inheritance diagram for ORKFramework.Events.BaseEvent:
ORKFramework.BaseNode ORKFramework.Events.IEventStarter ORKFramework.IStatusValueChangeSource ORKFramework.BaseIndexData ORKFramework.BaseData ORKFramework.IBaseData ORKFramework.Events.BattleEndEvent ORKFramework.Events.BattleEvent ORKFramework.Events.BattleStartEvent ORKFramework.Events.GameEvent ORKFramework.Events.MoveEvent ORKFramework.Events.PhaseChangeEvent

Public Member Functions

void DoPlayerBlock (int add)
void DoCameraBlock (int add)
override string GetNodeName ()
override string GetNodeDetails ()
override string GetNextName (int index)
override bool IsRemovable ()
override int GetNextCount ()
override int GetNext (int index)
override void SetNext (int index, int next)
abstract void StartEvent (IEventStarter s, object startingObject)
virtual void StopEvent (bool clearStarter)
void StepFinished (int next)
abstract void ExecuteNextStep ()
virtual void ExecuteNextStepStop ()
void WaitForButton (int[] id, float t, int[] next, int nextFail)
void WaitForStep (IStepUpdate waitStep, float t, int nextFail)
virtual void SetNextStep (int next)
void StartTime (float t, int next)
void StartContinue (float t, BaseEventStep s)
void Tick (float delta)
virtual Transform GetCamera ()
void ResetCameraPosition ()
abstract string GetActorName (int index)
abstract string GetActorShortName (int index)
abstract void ReplaceActorTextCodes (ref string text, int index)
abstract IPortrait GetActorPortrait (int index, int typeID)
abstract List< GameObject > GetActorObject (int index)
abstract List< CombatantGetActorCombatant (int index)
abstract List< GameObject > GetWaypoint (int index)
abstract GameObject SpawnPrefab (int index, Vector3 position, Vector3 rotation)
abstract void DestroyPrefab (int index, int spawnID, float time)
abstract List< GameObject > GetSpawnedPrefab (int index, int spawnID)
abstract AudioClip GetAudioClip (int index)
virtual void ChangeFoundObjects (string key, List< GameObject > list, ListChangeType changeType)
virtual List< GameObject > GetFoundObjects (string key)
virtual void GetFoundObjects (string key, ref List< GameObject > list)
int FoundObjectsCount (string key)
void CallMoveEvent (ORKMoveEvent eventAsset, List< GameObject > movingObject, int next, bool shareVariables, bool shareSelectedData, bool shareFoundObjects)
void CallGlobalEvent (ORKGameEvent eventAsset, object startingObject, int next, bool shareVariables, bool shareSelectedData, bool shareFoundObjects)
void CallBattleEvent (ORKBattleEvent eventAsset, int next, bool shareVariables, bool shareSelectedData, bool shareFoundObjects)
void EventEnded ()
void DontDestroy ()
void OnSceneLoaded ()
void SetGameOver ()
void SetExitGame ()
virtual void AddGUIBox (GUIBox box)
virtual void RemoveGUIBox (GUIBox box)
virtual void CloseAllGUIBoxes ()
- Public Member Functions inherited from ORKFramework.BaseNode
int GetFirstFree ()
- Public Member Functions inherited from ORKFramework.BaseData
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
virtual void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...

Public Attributes

int startIndex = -1
BaseEventStep [] step = new BaseEventStep[0]
- Public Attributes inherited from ORKFramework.BaseNode
Vector2 nodePosition = new Vector2(38, 38)
bool overrideNodeName = false
string nodeName = ""

Protected Member Functions

void StartEvent ()
abstract void EndEvent ()
bool CheckButtons (ref int next)

Protected Attributes

IEventStarter starter
bool executing = false
int currentStep = 0
int currentStepFail = 0
long stepCounter = 0
bool stopFlag = false
HashSet< int > stopList
VariableHandler variableHandler
SelectedDataHandler selectedData
bool checkButtons = false
int [] buttonID
int [] buttonNext
IStepUpdate waitStep
bool timeRunning = false
bool stepFinished = false
float time = 0.0f
bool noTimeDecrease = false
List< ContinueStepcontinueSteps = new List<ContinueStep>()
bool endAfterContinue = false
Transform camera
Transform initialCamParent
Vector3 initialCamPosition
Quaternion initialCamRotation
float initialFieldOfView
BaseEvent calledEvent
bool gameOver = false
bool exitGame = false
int playerBlocks = 0
int cameraBlocks = 0
Dictionary< string, List< GameObject > > foundObjects = new Dictionary<string, List<GameObject>>()
List< GUIBoxguiBox = new List<GUIBox>()
- Protected Attributes inherited from ORKFramework.BaseIndexData
int realID = 0


VariableHandler Variables [get, set]
SelectedDataHandler SelectedData [get, set]
bool Executing [get]
bool Stopping [get]
GameObject GameObject [get]
IEventStarter Starter [get]
Transform InitialCamParent [get]
Vector3 InitialCamPosition [get]
Quaternion InitialCamRotation [get]
float InitialFieldOfView [get]
virtual bool PerformCamera [get]
Dictionary< string, List< GameObject > > FoundObjects [get, set]
- Properties inherited from ORKFramework.BaseNode
virtual bool IsEnabled [get]
- Properties inherited from ORKFramework.BaseIndexData
virtual int RealID [get, set]
- Properties inherited from ORKFramework.Events.IEventStarter
GameObject GameObject [get]