Class BlockModuleBehaviour<TModule>

One of the two base classes for block modules. This class is the base for the behaviours attached to block game objects.

Inheritance
Object
ModBlockBehaviour
BlockModuleBehaviour<TModule>
ShootingModuleBehaviour
SpewingModuleBehaviour
SpinningModuleBehaviour
SteeringModuleBehaviour
Inherited Members
Namespace: Modding.Modules
Assembly: Assembly-CSharp.dll
Syntax
public abstract class BlockModuleBehaviour<TModule> : ModBlockBehaviour, IModuleBehaviour where TModule : BlockModule
Type Parameters
Name Description
TModule

BlockModule class for this module.

Constructors

BlockModuleBehaviour()

Declaration
protected BlockModuleBehaviour()

Properties

Module

Access to the BlockModule extending class instance.

Declaration
public TModule Module { get; }
Property Value
Type Description
TModule

ModuleGuid

Required for internal purposes. Should not be used from mods, not stable API.

Declaration
public string ModuleGuid { get; set; }
Property Value
Type Description
String

RawModule

Required for internal purposes, same value as Module but as object. Should not be used from mods, not stable API.

Declaration
public object RawModule { get; set; }
Property Value
Type Description
Object

Methods

GetColourSlider(MColourSliderReference)

Get an MColourSlider from an MColourSLiderReference.

Declaration
public MColourSlider GetColourSlider(MColourSliderReference slider)
Parameters
Type Name Description
MColourSliderReference slider
Returns
Type Description
MColourSlider

GetKey(MKeyReference)

Get an MKey form an MKeyReference.

Declaration
public MKey GetKey(MKeyReference key)
Parameters
Type Name Description
MKeyReference key
Returns
Type Description
MKey

GetResource(ResourceReference)

Get a shared resource from a ModuleResourceReference.

Declaration
public ModResource GetResource(ResourceReference reference)
Parameters
Type Name Description
ResourceReference reference
Returns
Type Description
ModResource

GetSlider(MSliderReference)

Get an MSlider from an MSliderReference.

Declaration
public MSlider GetSlider(MSliderReference slider)
Parameters
Type Name Description
MSliderReference slider
Returns
Type Description
MSlider

GetToggle(MToggleReference)

Get an MToggle from an MToggleReference.

Declaration
public MToggle GetToggle(MToggleReference toggle)
Parameters
Type Name Description
MToggleReference toggle
Returns
Type Description
MToggle

GetValue(MValueReference)

Get an MValue from an MValueReference.

Declaration
public MValue GetValue(MValueReference value)
Parameters
Type Name Description
MValueReference value
Returns
Type Description
MValue

OnReload()

Declaration
public virtual void OnReload()