Interface IIdDataShareAdapter
An interface to provide live IPC adapters that can invoke methods directly using custom IDs without the runtime overhead of IPC queries.
Remarks
Implement only methods you actually need. This can then be used to create a wrapper encapsulating the actually available methods or properties, either by the provider library, or on the consumer side.
Assembly: Dalamud.dll
public interface IIdDataShareAdapter : IDisposable
Methods
Invoke(int)
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke(int methodId)
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument.
The method should generally be implemented as a switch-statement.
Invoke<T1>(int, T1)
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke<T1>(int methodId, T1 argument1) where T1 : allows ref struct
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
<T1> | argument1 | The first argument. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument.
The method should generally be implemented as a switch-statement.
Invoke<T1, T2>(int, T1, T2)
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke<T1, T2>(int methodId, T1 argument1, T2 argument2) where T1 : allows ref struct where T2 : allows ref struct
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument.
The method should generally be implemented as a switch-statement.
Invoke<T1, T2, T3>(int, T1, T2, T3)
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke<T1, T2, T3>(int methodId, T1 argument1, T2 argument2, T3 argument3) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument.
The method should generally be implemented as a switch-statement.
Invoke<T1, T2, T3, T4>(int, T1, T2, T3, T4)
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke<T1, T2, T3, T4>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument.
The method should generally be implemented as a switch-statement.
Invoke<T1, T2, T3, T4, T5>(int, T1, T2, T3, T4, T5)
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke<T1, T2, T3, T4, T5>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4, T5 argument5) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct where T5 : allows ref struct
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
<T5> | argument5 | The fifth argument. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
T5 | The fifth parameter type. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument.
The method should generally be implemented as a switch-statement.
Invoke<T1, T2, T3, T4, T5, T6>(int, T1, T2, T3, T4, T5, T6)
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke<T1, T2, T3, T4, T5, T6>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4, T5 argument5, T6 argument6) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct where T5 : allows ref struct where T6 : allows ref struct
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
<T5> | argument5 | The fifth argument. |
<T6> | argument6 | The sixth argument. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
T5 | The fifth parameter type. This needs to be a type known to Dalamud again. |
T6 | The sixth parameter type. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument.
The method should generally be implemented as a switch-statement.
Invoke<T1, T2, T3, T4, T5, T6, T7>(int, T1, T2, T3, T4, T5, T6, T7)
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke<T1, T2, T3, T4, T5, T6, T7>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4, T5 argument5, T6 argument6, T7 argument7) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct where T5 : allows ref struct where T6 : allows ref struct where T7 : allows ref struct
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
<T5> | argument5 | The fifth argument. |
<T6> | argument6 | The sixth argument. |
<T7> | argument7 | The seventh argument. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
T5 | The fifth parameter type. This needs to be a type known to Dalamud again. |
T6 | The sixth parameter type. This needs to be a type known to Dalamud again. |
T7 | The seventh parameter type. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument.
The method should generally be implemented as a switch-statement.
Invoke<T1, T2, T3, T4, T5, T6, T7, T8>(int, T1, T2, T3, T4, T5, T6, T7, T8)
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke<T1, T2, T3, T4, T5, T6, T7, T8>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4, T5 argument5, T6 argument6, T7 argument7, T8 argument8) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct where T5 : allows ref struct where T6 : allows ref struct where T7 : allows ref struct where T8 : allows ref struct
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
<T5> | argument5 | The fifth argument. |
<T6> | argument6 | The sixth argument. |
<T7> | argument7 | The seventh argument. |
<T8> | argument8 | The eighth argument. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
T5 | The fifth parameter type. This needs to be a type known to Dalamud again. |
T6 | The sixth parameter type. This needs to be a type known to Dalamud again. |
T7 | The seventh parameter type. This needs to be a type known to Dalamud again. |
T8 | The eight parameter type. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument.
The method should generally be implemented as a switch-statement.
Invoke<T1, T2, T3, T4, T5, T6, T7, T8, T9>(int, T1, T2, T3, T4, T5, T6, T7, T8, T9)
Try to invoke an action by a custom integral ID using generic arguments.
void Invoke<T1, T2, T3, T4, T5, T6, T7, T8, T9>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4, T5 argument5, T6 argument6, T7 argument7, T8 argument8, T9 argument9) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct where T5 : allows ref struct where T6 : allows ref struct where T7 : allows ref struct where T8 : allows ref struct where T9 : allows ref struct
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The custom integral ID of the method. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
<T5> | argument5 | The fifth argument. |
<T6> | argument6 | The sixth argument. |
<T7> | argument7 | The seventh argument. |
<T8> | argument8 | The eighth argument. |
<T9> | argument9 | The ninth argument. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
T5 | The fifth parameter type. This needs to be a type known to Dalamud again. |
T6 | The sixth parameter type. This needs to be a type known to Dalamud again. |
T7 | The seventh parameter type. This needs to be a type known to Dalamud again. |
T8 | The eight parameter type. This needs to be a type known to Dalamud again. |
T9 | The ninth parameter type. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument.
The method should generally be implemented as a switch-statement.
TryInvoke<TRet>(int, out TRet?)
Try to invoke a function by a custom integral ID using generic arguments.
bool TryInvoke<TRet>(int methodId, out TRet? ret) where TRet : allows ref struct
Returns
System.Boolean: True if the invocation was successful, false otherwise.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The name of the method to invoke. |
<TRet> | ret | The returned value on success, undefined on failure. |
Type Parameters
| Name | Description |
|---|---|
TRet | The type of the returned value. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument or the return value.
The method should generally be implemented as a switch-statement.
TryInvoke<T1, TRet>(int, T1, out TRet?)
Try to invoke a function by a custom integral ID using generic arguments.
bool TryInvoke<T1, TRet>(int methodId, T1 argument1, out TRet? ret) where T1 : allows ref struct where TRet : allows ref struct
Returns
System.Boolean: True if the invocation was successful, false otherwise.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The name of the method to invoke. |
<T1> | argument1 | The first argument. |
<TRet> | ret | The returned value on success, undefined on failure. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
TRet | The type of the returned value. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument or the return value.
The method should generally be implemented as a switch-statement.
TryInvoke<T1, T2, TRet>(int, T1, T2, out TRet?)
Try to invoke a function by a custom integral ID using generic arguments.
bool TryInvoke<T1, T2, TRet>(int methodId, T1 argument1, T2 argument2, out TRet? ret) where T1 : allows ref struct where T2 : allows ref struct where TRet : allows ref struct
Returns
System.Boolean: True if the invocation was successful, false otherwise.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The name of the method to invoke. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<TRet> | ret | The returned value on success, undefined on failure. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
TRet | The type of the returned value. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument or the return value.
The method should generally be implemented as a switch-statement.
TryInvoke<T1, T2, T3, TRet>(int, T1, T2, T3, out TRet?)
Try to invoke a function by a custom integral ID using generic arguments.
bool TryInvoke<T1, T2, T3, TRet>(int methodId, T1 argument1, T2 argument2, T3 argument3, out TRet? ret) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where TRet : allows ref struct
Returns
System.Boolean: True if the invocation was successful, false otherwise.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The name of the method to invoke. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<TRet> | ret | The returned value on success, undefined on failure. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
TRet | The type of the returned value. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument or the return value.
The method should generally be implemented as a switch-statement.
TryInvoke<T1, T2, T3, T4, TRet>(int, T1, T2, T3, T4, out TRet?)
Try to invoke a function by a custom integral ID using generic arguments.
bool TryInvoke<T1, T2, T3, T4, TRet>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4, out TRet? ret) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct where TRet : allows ref struct
Returns
System.Boolean: True if the invocation was successful, false otherwise.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The name of the method to invoke. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
<TRet> | ret | The returned value on success, undefined on failure. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
TRet | The type of the returned value. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument or the return value.
The method should generally be implemented as a switch-statement.
TryInvoke<T1, T2, T3, T4, T5, TRet>(int, T1, T2, T3, T4, T5, out TRet?)
Try to invoke a function by a custom integral ID using generic arguments.
bool TryInvoke<T1, T2, T3, T4, T5, TRet>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4, T5 argument5, out TRet? ret) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct where T5 : allows ref struct where TRet : allows ref struct
Returns
System.Boolean: True if the invocation was successful, false otherwise.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The name of the method to invoke. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
<T5> | argument5 | The fifth argument. |
<TRet> | ret | The returned value on success, undefined on failure. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
T5 | The fifth parameter type. This needs to be a type known to Dalamud again. |
TRet | The type of the returned value. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument or the return value.
The method should generally be implemented as a switch-statement.
TryInvoke<T1, T2, T3, T4, T5, T6, TRet>(int, T1, T2, T3, T4, T5, T6, out TRet?)
Try to invoke a function by a custom integral ID using generic arguments.
bool TryInvoke<T1, T2, T3, T4, T5, T6, TRet>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4, T5 argument5, T6 argument6, out TRet? ret) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct where T5 : allows ref struct where T6 : allows ref struct where TRet : allows ref struct
Returns
System.Boolean: True if the invocation was successful, false otherwise.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The name of the method to invoke. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
<T5> | argument5 | The fifth argument. |
<T6> | argument6 | The sixth argument. |
<TRet> | ret | The returned value on success, undefined on failure. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
T5 | The fifth parameter type. This needs to be a type known to Dalamud again. |
T6 | The sixth parameter type. This needs to be a type known to Dalamud again. |
TRet | The type of the returned value. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument or the return value.
The method should generally be implemented as a switch-statement.
TryInvoke<T1, T2, T3, T4, T5, T6, T7, TRet>(int, T1, T2, T3, T4, T5, T6, T7, out TRet?)
Try to invoke a function by a custom integral ID using generic arguments.
bool TryInvoke<T1, T2, T3, T4, T5, T6, T7, TRet>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4, T5 argument5, T6 argument6, T7 argument7, out TRet? ret) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct where T5 : allows ref struct where T6 : allows ref struct where T7 : allows ref struct where TRet : allows ref struct
Returns
System.Boolean: True if the invocation was successful, false otherwise.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The name of the method to invoke. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
<T5> | argument5 | The fifth argument. |
<T6> | argument6 | The sixth argument. |
<T7> | argument7 | The seventh argument. |
<TRet> | ret | The returned value on success, undefined on failure. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
T5 | The fifth parameter type. This needs to be a type known to Dalamud again. |
T6 | The sixth parameter type. This needs to be a type known to Dalamud again. |
T7 | The seventh parameter type. This needs to be a type known to Dalamud again. |
TRet | The type of the returned value. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument or the return value.
The method should generally be implemented as a switch-statement.
TryInvoke<T1, T2, T3, T4, T5, T6, T7, T8, TRet>(int, T1, T2, T3, T4, T5, T6, T7, T8, out TRet?)
Try to invoke a function by a custom integral ID using generic arguments.
bool TryInvoke<T1, T2, T3, T4, T5, T6, T7, T8, TRet>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4, T5 argument5, T6 argument6, T7 argument7, T8 argument8, out TRet? ret) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct where T5 : allows ref struct where T6 : allows ref struct where T7 : allows ref struct where T8 : allows ref struct where TRet : allows ref struct
Returns
System.Boolean: True if the invocation was successful, false otherwise.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The name of the method to invoke. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
<T5> | argument5 | The fifth argument. |
<T6> | argument6 | The sixth argument. |
<T7> | argument7 | The seventh argument. |
<T8> | argument8 | The eighth argument. |
<TRet> | ret | The returned value on success, undefined on failure. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
T5 | The fifth parameter type. This needs to be a type known to Dalamud again. |
T6 | The sixth parameter type. This needs to be a type known to Dalamud again. |
T7 | The seventh parameter type. This needs to be a type known to Dalamud again. |
T8 | The eight parameter type. This needs to be a type known to Dalamud again. |
TRet | The type of the returned value. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument or the return value.
The method should generally be implemented as a switch-statement.
TryInvoke<T1, T2, T3, T4, T5, T6, T7, T8, T9, TRet>(int, T1, T2, T3, T4, T5, T6, T7, T8, T9, out TRet?)
Try to invoke a function by a custom integral ID using generic arguments.
bool TryInvoke<T1, T2, T3, T4, T5, T6, T7, T8, T9, TRet>(int methodId, T1 argument1, T2 argument2, T3 argument3, T4 argument4, T5 argument5, T6 argument6, T7 argument7, T8 argument8, T9 argument9, out TRet? ret) where T1 : allows ref struct where T2 : allows ref struct where T3 : allows ref struct where T4 : allows ref struct where T5 : allows ref struct where T6 : allows ref struct where T7 : allows ref struct where T8 : allows ref struct where T9 : allows ref struct where TRet : allows ref struct
Returns
System.Boolean: True if the invocation was successful, false otherwise.
Parameters
| Type | Name | Description |
|---|---|---|
System.Int32 | methodId | The name of the method to invoke. |
<T1> | argument1 | The first argument. |
<T2> | argument2 | The second argument. |
<T3> | argument3 | The third argument. |
<T4> | argument4 | The fourth argument. |
<T5> | argument5 | The fifth argument. |
<T6> | argument6 | The sixth argument. |
<T7> | argument7 | The seventh argument. |
<T8> | argument8 | The eighth argument. |
<T9> | argument9 | The ninth argument. |
<TRet> | ret | The returned value on success, undefined on failure. |
Type Parameters
| Name | Description |
|---|---|
T1 | The first parameter type. This needs to be a type known to Dalamud again. |
T2 | The second parameter type. This needs to be a type known to Dalamud again. |
T3 | The third parameter type. This needs to be a type known to Dalamud again. |
T4 | The fourth parameter type. This needs to be a type known to Dalamud again. |
T5 | The fifth parameter type. This needs to be a type known to Dalamud again. |
T6 | The sixth parameter type. This needs to be a type known to Dalamud again. |
T7 | The seventh parameter type. This needs to be a type known to Dalamud again. |
T8 | The eight parameter type. This needs to be a type known to Dalamud again. |
T9 | The ninth parameter type. This needs to be a type known to Dalamud again. |
TRet | The type of the returned value. This needs to be a type known to Dalamud again. |
Remarks
Should throw Dalamud.Plugin.Ipc.AdapterMethodMissingException if the requested method does not exist.
Should throw Dalamud.Plugin.Ipc.AdapterTypeMismatchException if the requested method can not handle a provided argument or the return value.
The method should generally be implemented as a switch-statement.