diff --git a/docs/api/Dalamud.ClientLanguage.html b/docs/api/Dalamud.ClientLanguage.html new file mode 100644 index 000000000..433b9dd0a --- /dev/null +++ b/docs/api/Dalamud.ClientLanguage.html @@ -0,0 +1,159 @@ + + + + + + + + Enum ClientLanguage + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Enum ClientLanguage +

+

Enum describing the language the game loads in.

+
+
+
Namespace: Dalamud
+
Assembly: Dalamud.dll
+
Syntax
+
+ 
public enum ClientLanguage
+
+

Fields +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
English
French
German
Japanese
+

Extension Methods

+ +
+
+ + +
+
+ + +
+ + + + + + diff --git a/docs/api/Dalamud.Dalamud.html b/docs/api/Dalamud.Dalamud.html new file mode 100644 index 000000000..3f080ec96 --- /dev/null +++ b/docs/api/Dalamud.Dalamud.html @@ -0,0 +1,317 @@ + + + + + + + + Class Dalamud + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Class Dalamud +

+
+
+
+
Inheritance
+
System.Object
+
Dalamud
+
+
+
Implements
+
System.IDisposable
+
+
+
Inherited Members
+
+ System.Object.ToString() +
+
+ System.Object.Equals(System.Object) +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
+ System.Object.GetHashCode() +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+
Namespace: Dalamud
+
Assembly: Dalamud.dll
+
Syntax
+
+ 
public sealed class Dalamud : IDisposable
+
+

Constructors +

+ + | + Improve this Doc + + + View Source + + +

Dalamud(DalamudStartInfo, LoggingLevelSwitch, ManualResetEvent)

+
+
+
Declaration
+
+ 
public Dalamud(DalamudStartInfo info, LoggingLevelSwitch loggingLevelSwitch, ManualResetEvent finishSignal)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
DalamudStartInfoinfo
Serilog.Core.LoggingLevelSwitchloggingLevelSwitch
System.Threading.ManualResetEventfinishSignal
+

Properties +

+ + | + Improve this Doc + + + View Source + + +

ClientState

+

ClientState subsystem

+
+
+
Declaration
+
+ 
public ClientState ClientState { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
ClientState
+

Methods +

+ + | + Improve this Doc + + + View Source + + +

Dispose()

+
+
+
Declaration
+
+ 
public void Dispose()
+
+ + | + Improve this Doc + + + View Source + + +

Start()

+
+
+
Declaration
+
+ 
public void Start()
+
+ + | + Improve this Doc + + + View Source + + +

Unload()

+
+
+
Declaration
+
+ 
public void Unload()
+
+ + | + Improve this Doc + + + View Source + + +

WaitForUnload()

+
+
+
Declaration
+
+ 
public void WaitForUnload()
+
+ + | + Improve this Doc + + + View Source + + +

WaitForUnloadFinish()

+
+
+
Declaration
+
+ 
public void WaitForUnloadFinish()
+
+

Implements

+
+ System.IDisposable +
+
+
+ + +
+
+ + +
+ + + + + + diff --git a/docs/api/Dalamud.DalamudStartInfo.html b/docs/api/Dalamud.DalamudStartInfo.html new file mode 100644 index 000000000..84922bf82 --- /dev/null +++ b/docs/api/Dalamud.DalamudStartInfo.html @@ -0,0 +1,390 @@ + + + + + + + + Class DalamudStartInfo + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Class DalamudStartInfo +

+
+
+
+
Inheritance
+
System.Object
+
DalamudStartInfo
+
+
+
Inherited Members
+
+ System.Object.ToString() +
+
+ System.Object.Equals(System.Object) +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
+ System.Object.GetHashCode() +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+
Namespace: Dalamud
+
Assembly: Dalamud.dll
+
Syntax
+
+ 
[Serializable]
+public sealed class DalamudStartInfo
+
+

Fields +

+ + | + Improve this Doc + + + View Source + +

AssetDirectory

+
+
+
Declaration
+
+ 
public string AssetDirectory
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.String
+ + | + Improve this Doc + + + View Source + +

ConfigurationPath

+
+
+
Declaration
+
+ 
public string ConfigurationPath
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.String
+ + | + Improve this Doc + + + View Source + +

DefaultPluginDirectory

+
+
+
Declaration
+
+ 
public string DefaultPluginDirectory
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.String
+ + | + Improve this Doc + + + View Source + +

GameVersion

+
+
+
Declaration
+
+ 
public string GameVersion
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.String
+ + | + Improve this Doc + + + View Source + +

Language

+
+
+
Declaration
+
+ 
public ClientLanguage Language
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
ClientLanguage
+ + | + Improve this Doc + + + View Source + +

OptOutMbCollection

+
+
+
Declaration
+
+ 
public bool OptOutMbCollection
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean
+ + | + Improve this Doc + + + View Source + +

PluginDirectory

+
+
+
Declaration
+
+ 
public string PluginDirectory
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.String
+ + | + Improve this Doc + + + View Source + +

WorkingDirectory

+
+
+
Declaration
+
+ 
public string WorkingDirectory
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.String
+
+
+ + +
+
+ + +
+ + + + + + diff --git a/docs/api/Dalamud.Data.DataManager.html b/docs/api/Dalamud.Data.DataManager.html index 8e4ef2bd8..8d1af6d17 100644 --- a/docs/api/Dalamud.Data.DataManager.html +++ b/docs/api/Dalamud.Data.DataManager.html @@ -143,7 +143,7 @@ - Dalamud.ClientLanguage + ClientLanguage language @@ -419,7 +419,7 @@ - Dalamud.ClientLanguage + ClientLanguage language

Language of the sheet to get.

@@ -602,7 +602,7 @@ - Dalamud.ClientLanguage + ClientLanguage iconLanguage

The requested language.

diff --git a/docs/api/Dalamud.EntryPoint.html b/docs/api/Dalamud.EntryPoint.html new file mode 100644 index 000000000..099104d80 --- /dev/null +++ b/docs/api/Dalamud.EntryPoint.html @@ -0,0 +1,241 @@ + + + + + + + + Class EntryPoint + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Class EntryPoint +

+
+
+
+
Inheritance
+
System.Object
+
EntryPoint
+
+
+
Implements
+
EasyHook.IEntryPoint
+
+
+
Inherited Members
+
+ System.Object.ToString() +
+
+ System.Object.Equals(System.Object) +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
+ System.Object.GetHashCode() +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+
Namespace: Dalamud
+
Assembly: Dalamud.dll
+
Syntax
+
+ 
public sealed class EntryPoint : IEntryPoint
+
+

Constructors +

+ + | + Improve this Doc + + + View Source + + +

EntryPoint(RemoteHooking.IContext, DalamudStartInfo)

+
+
+
Declaration
+
+ 
public EntryPoint(RemoteHooking.IContext ctx, DalamudStartInfo info)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
EasyHook.RemoteHooking.IContextctx
DalamudStartInfoinfo
+

Methods +

+ + | + Improve this Doc + + + View Source + + +

Run(RemoteHooking.IContext, DalamudStartInfo)

+
+
+
Declaration
+
+ 
public void Run(RemoteHooking.IContext ctx, DalamudStartInfo info)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
EasyHook.RemoteHooking.IContextctx
DalamudStartInfoinfo
+

Implements

+
+ EasyHook.IEntryPoint +
+
+
+ + +
+
+ + +
+ + + + + + diff --git a/docs/api/Dalamud.Game.ChatHandlers.html b/docs/api/Dalamud.Game.ChatHandlers.html index 40c43073b..8f697c13c 100644 --- a/docs/api/Dalamud.Game.ChatHandlers.html +++ b/docs/api/Dalamud.Game.ChatHandlers.html @@ -138,7 +138,7 @@ - Dalamud.Dalamud + Dalamud dalamud diff --git a/docs/api/Dalamud.Game.ClientState.Actors.ActorTable.html b/docs/api/Dalamud.Game.ClientState.Actors.ActorTable.html index 1d3b4fd70..27ce30131 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.ActorTable.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.ActorTable.html @@ -148,7 +148,7 @@ - Dalamud.Dalamud + Dalamud dalamud diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.BaseResolver.html b/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.BaseResolver.html index efb968055..403cb12a4 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.BaseResolver.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.BaseResolver.html @@ -140,7 +140,7 @@ - Dalamud.Dalamud + Dalamud dalamud @@ -172,7 +172,7 @@ - Dalamud.Dalamud + Dalamud diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.ClassJob.html b/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.ClassJob.html index fb062c5b5..8ae98de7d 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.ClassJob.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.ClassJob.html @@ -150,7 +150,7 @@ - Dalamud.Dalamud + Dalamud dalamud diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.World.html b/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.World.html index 1e50aba89..3c581a9f1 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.World.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Resolvers.World.html @@ -150,7 +150,7 @@ - Dalamud.Dalamud + Dalamud dalamud diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html index 1bcaeffee..4fc524b3e 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html @@ -158,7 +158,7 @@ - Dalamud.Dalamud + Dalamud dalamud

A dalamud reference needed to access game data in Resolvers.

@@ -251,7 +251,7 @@ - Dalamud.Dalamud + Dalamud diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html index 7f9dbc6a9..9b29e5c77 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html @@ -198,7 +198,7 @@ - Dalamud.Dalamud + Dalamud dalamud

A dalamud reference needed to access game data in Resolvers.

diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html index ecf107286..c568f2f2d 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html @@ -234,7 +234,7 @@ - Dalamud.Dalamud + Dalamud dalamud

A dalamud reference needed to access game data in Resolvers.

diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.EventObj.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.EventObj.html index 53dfcfc99..d177a9990 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.EventObj.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.EventObj.html @@ -196,7 +196,7 @@ - Dalamud.Dalamud + Dalamud dalamud

A dalamud reference needed to access game data in Resolvers.

diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html index 9058c09b2..e1dcb84df 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html @@ -231,7 +231,7 @@ - Dalamud.Dalamud + Dalamud dalamud

A dalamud reference needed to access game data in Resolvers.

diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html index 3c118e6da..414a558e6 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html @@ -227,7 +227,7 @@ - Dalamud.Dalamud + Dalamud dalamud

A dalamud reference needed to access game data in Resolvers.

diff --git a/docs/api/Dalamud.Game.ClientState.ClientState.html b/docs/api/Dalamud.Game.ClientState.ClientState.html index f9ab21db8..efcbc8e1e 100644 --- a/docs/api/Dalamud.Game.ClientState.ClientState.html +++ b/docs/api/Dalamud.Game.ClientState.ClientState.html @@ -145,13 +145,13 @@ - Dalamud.Dalamud + Dalamud dalamud

Dalamud instance

- Dalamud.DalamudStartInfo + DalamudStartInfo startInfo

StartInfo of the current Dalamud launch

@@ -220,7 +220,7 @@ - Dalamud.ClientLanguage + ClientLanguage diff --git a/docs/api/Dalamud.Game.ClientState.PartyList.html b/docs/api/Dalamud.Game.ClientState.PartyList.html index a039faf26..9b2134646 100644 --- a/docs/api/Dalamud.Game.ClientState.PartyList.html +++ b/docs/api/Dalamud.Game.ClientState.PartyList.html @@ -146,7 +146,7 @@ - Dalamud.Dalamud + Dalamud dalamud diff --git a/docs/api/Dalamud.Game.Command.CommandManager.html b/docs/api/Dalamud.Game.Command.CommandManager.html index b74e8a6e2..bec3d07c3 100644 --- a/docs/api/Dalamud.Game.Command.CommandManager.html +++ b/docs/api/Dalamud.Game.Command.CommandManager.html @@ -139,12 +139,12 @@ - Dalamud.Dalamud + Dalamud dalamud - Dalamud.ClientLanguage + ClientLanguage language diff --git a/docs/api/Dalamud.Game.Internal.File.ResourceManager.html b/docs/api/Dalamud.Game.Internal.File.ResourceManager.html index f60b5c20d..0b9ad678c 100644 --- a/docs/api/Dalamud.Game.Internal.File.ResourceManager.html +++ b/docs/api/Dalamud.Game.Internal.File.ResourceManager.html @@ -138,7 +138,7 @@ - Dalamud.Dalamud + Dalamud dalamud diff --git a/docs/api/Dalamud.Game.Internal.Framework.html b/docs/api/Dalamud.Game.Internal.Framework.html index 735f0cc7e..ffe1e4808 100644 --- a/docs/api/Dalamud.Game.Internal.Framework.html +++ b/docs/api/Dalamud.Game.Internal.Framework.html @@ -148,7 +148,7 @@ - Dalamud.Dalamud + Dalamud dalamud diff --git a/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html index 6ae071d30..23518ea7e 100644 --- a/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html +++ b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html @@ -152,7 +152,7 @@ - Dalamud.Dalamud + Dalamud dalamud diff --git a/docs/api/Dalamud.Game.Internal.Gui.GameGui.html b/docs/api/Dalamud.Game.Internal.Gui.GameGui.html index da87b212e..08cc2e041 100644 --- a/docs/api/Dalamud.Game.Internal.Gui.GameGui.html +++ b/docs/api/Dalamud.Game.Internal.Gui.GameGui.html @@ -152,7 +152,7 @@ - Dalamud.Dalamud + Dalamud dalamud diff --git a/docs/api/Dalamud.Game.Internal.Gui.TargetManager.html b/docs/api/Dalamud.Game.Internal.Gui.TargetManager.html index 75db2f4bd..577f14862 100644 --- a/docs/api/Dalamud.Game.Internal.Gui.TargetManager.html +++ b/docs/api/Dalamud.Game.Internal.Gui.TargetManager.html @@ -138,7 +138,7 @@ - Dalamud.Dalamud + Dalamud dalamud diff --git a/docs/api/Dalamud.Game.Network.NetworkHandlers.html b/docs/api/Dalamud.Game.Network.NetworkHandlers.html index 84071e910..1a1eba26c 100644 --- a/docs/api/Dalamud.Game.Network.NetworkHandlers.html +++ b/docs/api/Dalamud.Game.Network.NetworkHandlers.html @@ -138,7 +138,7 @@ - Dalamud.Dalamud + Dalamud dalamud diff --git a/docs/api/Dalamud.SafeMemory.html b/docs/api/Dalamud.SafeMemory.html new file mode 100644 index 000000000..40164998e --- /dev/null +++ b/docs/api/Dalamud.SafeMemory.html @@ -0,0 +1,879 @@ + + + + + + + + Class SafeMemory + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Class SafeMemory +

+

Class facilitating safe memory access

+
+
+
+
Inheritance
+
System.Object
+
SafeMemory
+
+
+
Inherited Members
+
+ System.Object.ToString() +
+
+ System.Object.Equals(System.Object) +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
+ System.Object.GetHashCode() +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+
Namespace: Dalamud
+
Assembly: Dalamud.dll
+
Syntax
+
+ 
public static class SafeMemory
+
+
Remarks
+

Attention! The performance of these methods is severely worse than regular System.Runtime.InteropServices.Marshal calls. +Please consider using these instead in performance-critical code.

+
+

Methods +

+ + | + Improve this Doc + + + View Source + + +

Read<T>(IntPtr, out T)

+

Read an object of the specified struct from the current process.

+
+
+
Declaration
+
+ 
public static bool Read<T>(IntPtr address, out T result)
+    where T : struct
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.IntPtraddress

The address to read from.

+
Tresult

The resulting object.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

Whether or not the read succeeded.

+
+
Type Parameters
+ + + + + + + + + + + + + +
NameDescription
T

The type of the struct.

+
+ + | + Improve this Doc + + + View Source + + +

Read<T>(IntPtr, Int32)

+

Read an array of objects of the specified struct from the current process.

+
+
+
Declaration
+
+ 
[CanBeNull]
+public static T[] Read<T>(IntPtr address, int count)
+    where T : struct
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.IntPtraddress

The address to read from.

+
System.Int32count

The length of the array.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
T[]

An array of the read objects, or null if any entry of the array failed to read.

+
+
Type Parameters
+ + + + + + + + + + + + + +
NameDescription
T

The type of the struct.

+
+ + | + Improve this Doc + + + View Source + + +

ReadBytes(IntPtr, Int32, out Byte[])

+

Read a byte array from the current process.

+
+
+
Declaration
+
+ 
public static bool ReadBytes(IntPtr address, int count, out byte[] buffer)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.IntPtraddress

The address to read from.

+
System.Int32count

The amount of bytes to read.

+
System.Byte[]buffer

The result buffer.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

Whether or not the read succeeded.

+
+ + | + Improve this Doc + + + View Source + + +

ReadString(IntPtr, Int32)

+

Read a string from the current process(UTF-8).

+
+
+
Declaration
+
+ 
[CanBeNull]
+public static string ReadString(IntPtr address, int maxLength = 256)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.IntPtraddress

The address to read from.

+
System.Int32maxLength

The maximum length of the string.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.String

The read string, or null in case the read was not successful.

+
+
Remarks
+

Attention! This will use the .NET Encoding.UTF8 class to decode the text. +If you read a FFXIV string, please use ReadBytes and parse the string with the applicable class, +since Encoding.UTF8 destroys the FFXIV payload structure.

+
+ + | + Improve this Doc + + + View Source + + +

ReadString(IntPtr, Encoding, Int32)

+

Read a string from the current process(UTF-8).

+
+
+
Declaration
+
+ 
[CanBeNull]
+public static string ReadString(IntPtr address, Encoding encoding, int maxLength = 256)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.IntPtraddress

The address to read from.

+
System.Text.Encodingencoding

The encoding to use to decode the string.

+
System.Int32maxLength

The maximum length of the string.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.String

The read string, or null in case the read was not successful.

+
+
Remarks
+

Attention! This will use the .NET Encoding class to decode the text. +If you read a FFXIV string, please use ReadBytes and parse the string with the applicable class, +since Encoding may destroy the FFXIV payload structure.

+
+ + | + Improve this Doc + + + View Source + + +

SizeOf<T>()

+

Get the size of the passed type.

+
+
+
Declaration
+
+ 
public static int SizeOf<T>()
+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Int32

The size of the passed type.

+
+
Type Parameters
+ + + + + + + + + + + + + +
NameDescription
T

The type to inspect.

+
+ + | + Improve this Doc + + + View Source + + +

Write<T>(IntPtr, T)

+

Write a struct to the current process.

+
+
+
Declaration
+
+ 
public static bool Write<T>(IntPtr address, T obj)
+    where T : struct
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.IntPtraddress

The address to write to.

+
Tobj

The object to write.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

Whether or not the write succeeded.

+
+
Type Parameters
+ + + + + + + + + + + + + +
NameDescription
T

The type of the struct.

+
+ + | + Improve this Doc + + + View Source + + +

Write<T>(IntPtr, T[])

+

Write an array of structs to the current process.

+
+
+
Declaration
+
+ 
public static bool Write<T>(IntPtr address, T[] objArray)
+    where T : struct
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.IntPtraddress

The address to write to.

+
T[]objArray

The array to write.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

Whether or not the write succeeded.

+
+
Type Parameters
+ + + + + + + + + + + + + +
NameDescription
T

The type of the structs.

+
+ + | + Improve this Doc + + + View Source + + +

WriteBytes(IntPtr, Byte[])

+

Write a byte array to the current process.

+
+
+
Declaration
+
+ 
public static bool WriteBytes(IntPtr address, byte[] buffer)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.IntPtraddress

The address to write to.

+
System.Byte[]buffer

The buffer to write.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

Whether or not the write succeeded.

+
+ + | + Improve this Doc + + + View Source + + +

WriteString(IntPtr, String)

+

Write a string to the current process.

+
+
+
Declaration
+
+ 
public static bool WriteString(IntPtr address, string str)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.IntPtraddress

The address to write to.

+
System.Stringstr

The string to write.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

Whether or not the write succeeded.

+
+
Remarks
+

Attention! This will use the .NET Encoding class to encode the text. +If you read a FFXIV string, please use WriteBytes with the applicable encoded SeString, +since Encoding may destroy the FFXIV payload structure.

+
+ + | + Improve this Doc + + + View Source + + +

WriteString(IntPtr, String, Encoding)

+

Write a string to the current process.

+
+
+
Declaration
+
+ 
public static bool WriteString(IntPtr address, string str, Encoding encoding)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.IntPtraddress

The address to write to.

+
System.Stringstr

The string to write.

+
System.Text.Encodingencoding

The encoding to use.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

Whether or not the write succeeded.

+
+
Remarks
+

Attention! This will use the .NET Encoding class to encode the text. +If you read a FFXIV string, please use WriteBytes with the applicable encoded SeString, +since Encoding may destroy the FFXIV payload structure.

+
+
+
+ + +
+
+ + +
+ + + + + + diff --git a/docs/api/Dalamud.html b/docs/api/Dalamud.html new file mode 100644 index 000000000..4b5ef22ac --- /dev/null +++ b/docs/api/Dalamud.html @@ -0,0 +1,130 @@ + + + + + + + + Namespace Dalamud + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+ +
+ + +
+
+ + +
+ + + + + + diff --git a/docs/api/toc.html b/docs/api/toc.html index b52666c1d..f9fd881aa 100644 --- a/docs/api/toc.html +++ b/docs/api/toc.html @@ -12,6 +12,28 @@