My Project
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
RoslynCSharp.Modding.ModReplaceableBehaviourAttribute Class Reference

Add this attribute to a component type to allow it to be replaced with an externally compiled mod script. Used in conjuection with the ModScriptReplacer. More...

Inheritance diagram for RoslynCSharp.Modding.ModReplaceableBehaviourAttribute:

Public Member Functions

 ModReplaceableBehaviourAttribute (string replaceScriptName="", Type requireBaseType=null, params Type[] requireInterfaceTypes)
 Crfeate a new instance.
 

Properties

string ReplaceScriptName [get]
 The name of the script override. The external script must define a class which matches this type name exactly in order to be replaced.
 
Type RequireBaseType [get]
 An optional base type that the external class must inherit from in order for script replacement to occur.
 
Type[] RequireInterfaceTypes [get]
 An optional array of interface types that the external class must implement in order for script replacement to occur.
 

Detailed Description

Add this attribute to a component type to allow it to be replaced with an externally compiled mod script. Used in conjuection with the ModScriptReplacer.

Constructor & Destructor Documentation

◆ ModReplaceableBehaviourAttribute()

RoslynCSharp.Modding.ModReplaceableBehaviourAttribute.ModReplaceableBehaviourAttribute ( string  replaceScriptName = "",
Type  requireBaseType = null,
params Type[]  requireInterfaceTypes 
)
inline

Crfeate a new instance.

Parameters
replaceScriptNameThe replacement script name
requireBaseTypeAn optional base type that the external script must inherit from, or null if a required base type is not needed
requireInterfaceTypesAn optional array of interface types that the external script must implement, or an empty array if interface implementations are not needed

The documentation for this class was generated from the following file: