Appearance

Debology.Debby.Modules.Adjust ​

IAdjustModule Interface ​

The API for interacting with the Adjust module. This can be accessed via Adjust.

csharp
public interface IAdjustModule

Methods ​

IAdjustModule.GetContext<T>() Method ​

Returns an instance of the context registered with the Adjust module.

csharp
T GetContext<T>()
    where T : class;

Type parameters ​

T

The type of context to fetch

Returns ​

T
The instance of the context being used by Adjust

IAdjustModule.NewContext(string, GameObject, AdjustContextAttribute) Method ​

Creates a new ContextBuilder for adding an Adjust module.

Remember to call Build!

csharp
Debology.Debby.Modules.Adjust.IContextBuilder NewContext(string name, GameObject gameObject=null, Debology.Debby.Modules.Adjust.Attributes.AdjustContextAttribute config=null);

Parameters ​

name System.String

The name of the context

gameObject UnityEngine.GameObject

An optional GameObject used to control the lifecycle of the context

config AdjustContextAttribute

An optional set of additional configs for the context

Returns ​

IContextBuilder
The context builder

IAdjustModule.Open() Method ​

Opens the Adjust module.

csharp
void Open();

IAdjustModule.RegisterContext(object, string, GameObject, AdjustContextAttribute) Method ​

Registers a new context for the Adjust module from the provided instance. If the gameObject is specified the lifetime of the context will be tied to the GameObject.

csharp
void RegisterContext(object context, string name=null, GameObject gameObject=null, Debology.Debby.Modules.Adjust.Attributes.AdjustContextAttribute configOverride=null);

Parameters ​

context System.Object

The instance of the context to register

name System.String

The name of the context

gameObject UnityEngine.GameObject

An optional GameObject

configOverride AdjustContextAttribute

Overrides the AdjustContextAttribute placed on the class

IAdjustModule.RegisterContext<T>(string, GameObject, AdjustContextAttribute) Method ​

Registers a new context for the Adjust module from the provided type. If the gameObject is specified the lifetime of the context will be tied to the GameObject.

csharp
void RegisterContext<T>(string name=null, GameObject gameObject=null, Debology.Debby.Modules.Adjust.Attributes.AdjustContextAttribute configOverride=null)
    where T : new();

Type parameters ​

T

The type of context to register

Parameters ​

name System.String

The name of the context

gameObject UnityEngine.GameObject

An optional GameObject

configOverride AdjustContextAttribute

Overrides the AdjustContextAttribute placed on the class

IAdjustModule.RegisterTypeAdapter<TAdapter,TValue,TAttribute>() Method ​

Registers a custom element adapter for a specific value type. This allows extending the Adjust module with custom UI controls for custom types.

csharp
void RegisterTypeAdapter<TAdapter,TValue,TAttribute>()
    where TAdapter : Debology.Debby.Modules.Adjust.Adapters.AdjustTypeAdapter<TValue, TAttribute>, new()
    where TAttribute : Debology.Debby.Modules.Adjust.Attributes.AdjustAttribute;

Type parameters ​

TAdapter

The adapter class that creates UI elements

TValue

The value type this adapter handles

TAttribute

The attribute type associated with this adapter

IAdjustModule.RegisterTypeAdapter<TAdapter,TValue>() Method ​

Registers a custom element adapter for a specific value type. This allows extending the Adjust module with custom UI controls for custom types.

csharp
void RegisterTypeAdapter<TAdapter,TValue>()
    where TAdapter : Debology.Debby.Modules.Adjust.Adapters.AdjustTypeAdapter<TValue>, new();

Type parameters ​

TAdapter

The adapter class that creates UI elements

TValue

The value type this adapter handles

IAdjustModule.UnregisterContext(object) Method ​

Removes a context from the Adjust module.

csharp
void UnregisterContext(object context);

Parameters ​

context System.Object

The context to unregister

IAdjustModule.UnregisterContext<T>() Method ​

Removes a context from the Adjust module.

csharp
void UnregisterContext<T>()
    where T : new();

Type parameters ​

T