Header menu logo Nu

NuPlugin Type

Provides a way to make user-defined dispatchers, facets, and various other sorts of game- specific values and configurations.

Constructors

Constructor Description

NuPlugin()

Full Usage: NuPlugin()

Returns: NuPlugin
Returns: NuPlugin

Instance members

Instance member Description

this.AllowCodeReload

Full Usage: this.AllowCodeReload

Returns: bool
Modifiers: abstract

Whether or not code reloading is permitted by current plugin

Returns: bool

this.CleanUp

Full Usage: this.CleanUp

Modifiers: abstract

Clean-up any user-defined resources of the plugin, such with shutting down a Steamworks API.

this.EditModes

Full Usage: this.EditModes

Returns: Map<string, (World -> unit)>
Modifiers: abstract

Provides a list of modes for setting game state via the editor.

Returns: Map<string, (World -> unit)>

this.ImGuiPostProcess

Full Usage: this.ImGuiPostProcess

Parameters:
Modifiers: abstract

A call-back for imgui post-processing.

world : World

this.ImGuiProcess

Full Usage: this.ImGuiProcess

Parameters:
Modifiers: abstract

A call-back for imgui processing.

world : World

this.InitialPackages

Full Usage: this.InitialPackages

Returns: string list
Modifiers: abstract

The packages that should be loaded at start-up in all contexts, including in audio player, renderers, and metadata. The Default package is always included.

Returns: string list

this.Invoke

Full Usage: this.Invoke

Parameters:
    callbackName : string
    callbackArgs : obj list
    world : World

Modifiers: abstract

Invoke a user-defined callback.

callbackName : string
callbackArgs : obj list
world : World

this.MakeKeyedValues

Full Usage: this.MakeKeyedValues

Parameters:
Returns: (string * obj) list
Modifiers: abstract

Make a list of keyed values to hook into the engine.

world : World
Returns: (string * obj) list

this.PerProcess

Full Usage: this.PerProcess

Parameters:
Modifiers: abstract

A call-back during each frame.

world : World

this.PostProcess

Full Usage: this.PostProcess

Parameters:
Modifiers: abstract

A call-back at the end of each frame.

world : World

this.PreProcess

Full Usage: this.PreProcess

Parameters:
Modifiers: abstract

A call-back at the beginning of each frame.

world : World

this.TryMakeEmitter

Full Usage: this.TryMakeEmitter

Parameters:
    time : GameTime
    lifeTimeOpt : GameTime
    particleLifeTimeOpt : GameTime
    particleRate : single
    particleMax : int
    emitterName : string

Returns: Emitter option
Modifiers: abstract

Attempt to make an emitter of the given name.

time : GameTime
lifeTimeOpt : GameTime
particleLifeTimeOpt : GameTime
particleRate : single
particleMax : int
emitterName : string
Returns: Emitter option

Type something to start searching.