Skip to main content

Struct Framework

Assembly: FFXIVClientStructs.dll
Declaration
public struct Framework

Properties

GamePath

View Source
Declaration
public string GamePath { get; }

SqPackPath

View Source
Declaration
public string SqPackPath { get; }

UserPath

View Source
Declaration
public string UserPath { get; }

Fields

SystemConfig

View Source
Declaration
public SystemConfig SystemConfig

DevConfig

View Source
Declaration
public DevConfig DevConfig

SavedAppearanceData

View Source
Declaration
public SavedAppearanceManager* SavedAppearanceData

ClientLanguage

View Source
Declaration
public byte ClientLanguage

Region

View Source
Declaration
public byte Region

Cursor

View Source
Declaration
public Cursor* Cursor

CallerWindow

View Source
Declaration
public nint CallerWindow

ConfigPath

View Source
Declaration
public FileAccessPath ConfigPath

GameWindow

View Source
Declaration
public GameWindow* GameWindow

CursorPosX

View Source
Declaration
public int CursorPosX

CursorPosY

View Source
Declaration
public int CursorPosY

CursorPosX2

View Source
Declaration
public int CursorPosX2

CursorPosY2

View Source
Declaration
public int CursorPosY2

NetworkModuleProxy

View Source
Declaration
public NetworkModuleProxy* NetworkModuleProxy

IsNetworkModuleInitialized

View Source
Declaration
public bool IsNetworkModuleInitialized

EnableNetworking

View Source
Declaration
public bool EnableNetworking

UtcTime

View Source
Declaration
public TimePoint UtcTime

ServerTime

View Source
Declaration
[Obsolete("Use UtcTime.Timestamp")]
public long ServerTime

PerformanceCounterInMilliSeconds

View Source
Declaration
[Obsolete("Use UtcTime.CpuMilliSeconds")]
public long PerformanceCounterInMilliSeconds

PerformanceCounterInMicroSeconds

View Source
Declaration
[Obsolete("Use UtcTime.CpuMicroSeconds")]
public long PerformanceCounterInMicroSeconds

TimerResolutionMillis

View Source
Declaration
public uint TimerResolutionMillis

PerformanceCounterFrequency

View Source
Declaration
public long PerformanceCounterFrequency

PerformanceCounterValue

View Source
Declaration
public long PerformanceCounterValue

FrameDeltaTime

Frame time (in seconds) to use for calculating animations, tasks, game logic and such. This is not necessarily the real time since the last frame.

View Source
Declaration
public float FrameDeltaTime

RealFrameDeltaTime

Holds the unaltered real time since last frame in seconds.

View Source
Declaration
public float RealFrameDeltaTime

FrameDeltaTimeOverride

If set to anything non-zero, overrides FFXIVClientStructs.FFXIV.Client.System.Framework.Framework.FrameDeltaTime. Has lower precedence than FFXIVClientStructs.FFXIV.Client.System.Framework.Framework.FrameDeltaTimeOverride2.

View Source
Declaration
public float FrameDeltaTimeOverride

FrameDeltaFactor

If non-zero FFXIVClientStructs.FFXIV.Client.System.Framework.Framework.FrameDeltaTime is multiplied with this.

View Source
Declaration
public float FrameDeltaFactor

FrameCounter

View Source
Declaration
public uint FrameCounter

TaskManager

View Source
Declaration
public TaskManager TaskManager

ClientTime

View Source
Declaration
public ClientTime ClientTime

EorzeaTime

View Source
Declaration
[Obsolete("Use ClientTime.EorzeaTime")]
public long EorzeaTime

EorzeaTimeOverride

View Source
Declaration
[Obsolete("Use ClientTime.EorzeaTimeOverride")]
public long EorzeaTimeOverride

IsEorzeaTimeOverridden

View Source
Declaration
[Obsolete("Use ClientTime.IsEorzeaTimeOverridden")]
public bool IsEorzeaTimeOverridden

FrameRate

View Source
Declaration
public float FrameRate

DiscardFrame

If true FFXIVClientStructs.FFXIV.Client.System.Framework.Framework.FrameDeltaTime is set to 0.

View Source
Declaration
public bool DiscardFrame

FrameDeltaTimeOverride2

If set to anything non-zero, overrides FFXIVClientStructs.FFXIV.Client.System.Framework.Framework.FrameDeltaTime. If negative FFXIVClientStructs.FFXIV.Client.System.Framework.Framework.FrameDeltaTimeOverride is used and 60fps as a fallback.

View Source
Declaration
public float FrameDeltaTimeOverride2

WindowInactive

View Source
Declaration
public bool WindowInactive

DataPathType

View Source
Declaration
public int DataPathType

ExcelModuleInterface

View Source
Declaration
public ExcelModuleInterface* ExcelModuleInterface

ExdModule

View Source
Declaration
public ExdModule* ExdModule

BGCollisionModule

View Source
Declaration
public BGCollisionModule* BGCollisionModule

UIModule

View Source
Declaration
public UIModule* UIModule

UIClipboard

View Source
Declaration
public UIClipboard* UIClipboard

EnvironmentManager

View Source
Declaration
public EnvironmentManager* EnvironmentManager

SoundManager

View Source
Declaration
public SoundManager* SoundManager

LuaState

View Source
Declaration
public LuaState LuaState

GameVersion

View Source
Declaration
public GameVersion GameVersion

UseWatchDogThread

View Source
Declaration
public bool UseWatchDogThread

FramesUntilDebugCheck

View Source
Declaration
public int FramesUntilDebugCheck

IsSteamGame

Set if IsSteam was set for this instance as part of SetupSteamApi. Set even if loading the Steam API fails for some reason.

View Source
Declaration
public bool IsSteamGame

SteamApi

Access the Steam API wrapper/interface.

View Source
Declaration
public SteamApi* SteamApi

SteamApiLibraryHandle

Handle (type HMODULE) of steam_api64.dll

View Source
Declaration
public nint SteamApiLibraryHandle

Methods

Instance()

View Source
Declaration
[StaticAddress("44 0F B6 C0 48 8B 0D ?? ?? ?? ??", 7, true)]
public static Framework* Instance()
Returns

FFXIVClientStructs.FFXIV.Client.System.Framework.Framework*

GetUiModule()

View Source
Declaration
[MemberFunction("E8 ?? ?? ?? ?? 80 7B 1D 01")]
public UIModule* GetUiModule()
Returns

FFXIVClientStructs.FFXIV.Client.UI.UIModule*

GetUIClipboard()

View Source
Declaration
[MemberFunction("E8 ?? ?? ?? ?? 4C 8B 44 24 ?? 48 8B C8 48 8B D3")]
public UIClipboard* GetUIClipboard()
Returns

FFXIVClientStructs.FFXIV.Client.UI.UIClipboard*

GetNetworkModuleProxy()

View Source
Declaration
[MemberFunction("80 B9 ?? ?? ?? ?? 00 74 ?? 48 8B 81 ?? ?? ?? ?? C3")]
public NetworkModuleProxy* GetNetworkModuleProxy()
Returns

FFXIVClientStructs.FFXIV.Client.Network.NetworkModuleProxy*

GetServerTime()

View Source
Declaration
[MemberFunction("E8 ?? ?? ?? ?? 89 47 2C")]
public static long GetServerTime()
Returns

System.Int64

IsSteamApiInitialized()

Checks if the Steam API has been initialized by checking whether the FFXIVClientStructs.FFXIV.Client.System.Framework.Framework.SteamApi pointer is valid, and whether the sub-struct reports itself as ready.

View Source
Declaration
[MemberFunction("E8 ?? ?? ?? ?? 88 43 08 84 C0 74 16")]
public bool IsSteamApiInitialized()
Returns

System.Boolean: Returns true if the API is ready, false otherwise.