Helper

Helper

Description

General helper for scenes. Do not use it. This class is deprecated since ModLoader 1.3.0.

Events

OnUpdateBaseScene

Fired every frame in the Base Scene

// how to suscribe
Helper.OnUpdateBaseScene += this.MyMethod;

// Method example
void MyMethod(object sender, EventArgs args){
  // code here...
}

---

OnUpdateHomeScene

Fired every frame in the Home Scene

// how to suscribe
Helper.OnUpdateHomeScene += this.MyMethod;

// Method example
void MyMethod(object sender, EventArgs args){
  // code here...
}

---

OnUpdateBuildScene

Fired every frame in the Build Scene

// how to suscribe
Helper.OnUpdateBuildScene += this.MyMethod;

// Method example
void MyMethod(object sender, EventArgs args){
  // code here...
}

---

OnUpdateWorldScene

Fired every frame in the World Scene

// how to suscribe
Helper.OnUpdateWorldScene += this.MyMethod;

// Method example
void MyMethod(object sender, EventArgs args){
  // code here...
}

OnBaseSceneLoaded

Fired when the Base Scene (the first scene when game loads) is loaded

// how to suscribe
Helper.OnBaseSceneLoaded += this.MyMethod;

// Method example
void MyMethod(object sender, EventArgs args){
  // code here...
}

OnHomeSceneLoaded

Fired when the start menu scene loaded -> After player has gone to another scene and come back

// how to suscribe
Helper.OnHomeSceneLoaded += this.MyMethod;

// Method example
void MyMethod(object sender, EventArgs args){
  // code here...
}

OnBuildSceneLoaded

Fired when the Build Scene is loaded

// how to suscribe
Helper.OnBuildSceneLoaded += this.MyMethod;

// Method example
void MyMethod(object sender, EventArgs args){
  // code here...
}

OnWorldSceneLoaded

Fired when the World Scene is Loaded

// how to suscribe
Helper.OnWorldSceneLoaded += this.MyMethod;

// Method example
void MyMethod(object sender, EventArgs args){
  // code here...
}

Properties

Name	Description
currentScene	Get enum with the current scene

Public Methods

There are not public methods for this class.