/// <summary>
/// Gets the list of Weather UI elements
/// </summary>
/// <returns>A list containing XivUi data</returns>
public async Task <List <XivUi> > GetWeatherList()
{
var weatherLock = new object();
var weatherList = new List <XivUi>();
// These are the offsets to relevant data
// These will need to be changed if data gets added or removed with a patch
const int nameLengthOffset = 6;
const int iconNumberOffset = 26;
var weatherExData = await _ex.ReadExData(XivEx.weather);
var weatherNames = new List <string>();
await Task.Run(() => Parallel.ForEach(weatherExData.Values, (weather) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Weather
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(weather)))
{
br.BaseStream.Seek(nameLengthOffset, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
br.BaseStream.Seek(iconNumberOffset, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.IconNumber = iconNumber;
xivUi.Name = name;
}
if (weatherNames.Contains(xivUi.Name))
{
return;
}
lock (weatherLock)
{
weatherNames.Add(xivUi.Name);
weatherList.Add(xivUi);
}
}));
weatherList.Sort();
return(weatherList);
}
/// <summary>
/// Gets a list of UI elements from the Uld Files
/// </summary>
/// <remarks>
/// The uld files are in the 06 files
/// They contain refrences to textures among other unknown things (likely placement data)
/// </remarks>
/// <returns>A list containing XivUi data</returns>
public List <XivUi> GetUldList()
{
var uldList = new List <XivUi>();
var uld = new Uld(_gameDirectory);
var uldPaths = uld.GetTexFromUld();
// Loops through the list of uld paths
foreach (var uldPath in uldPaths)
{
var xivUi = new XivUi
{
Name = Path.GetFileNameWithoutExtension(uldPath),
Category = "UI",
ItemCategory = "HUD",
UiPath = "ui/uld"
};
uldList.Add(xivUi);
}
uldList.Sort();
return(uldList);
}
/// <summary>
/// Gets a list of UI elements from the Uld Files
/// </summary>
/// <remarks>
/// The uld files are in the 06 files
/// They contain refrences to textures among other unknown things (likely placement data)
/// </remarks>
/// <returns>A list containing XivUi data</returns>
public async Task <List <XivUi> > GetUldList()
{
var uldLock = new object();
var uldList = new List <XivUi>();
var uld = new Uld(_gameDirectory);
var uldPaths = await uld.GetTexFromUld();
await Task.Run(() => Parallel.ForEach(uldPaths, (uldPath) =>
{
var xivUi = new XivUi
{
Name = Path.GetFileNameWithoutExtension(uldPath),
PrimaryCategory = "UI",
SecondaryCategory = "HUD",
UiPath = "ui/uld"
};
if (xivUi.Name.Equals(string.Empty))
{
return;
}
lock (uldLock)
{
uldList.Add(xivUi);
}
}));
uldList.Sort();
return(uldList);
}
/// <summary>
/// Get the ui entries list, optionally with a substring filter.
/// </summary>
/// <param name="substring"></param>
/// <returns></returns>
public async Task <List <XivUi> > GetCachedUiList(string substring = null)
{
WhereClause where = null;
if (substring != null)
{
where = new WhereClause();
where.Comparer = WhereClause.ComparisonType.Like;
where.Column = "name";
where.Value = "%" + substring + "%";
}
return(await BuildListFromTable("ui", where, async (reader) =>
{
var item = new XivUi
{
PrimaryCategory = XivStrings.UI,
SecondaryCategory = reader.GetString("category"),
TertiaryCategory = reader.GetString("subcategory"),
Name = reader.GetString("name"),
IconNumber = reader.GetInt32("icon_id"),
UiPath = reader.GetString("path"),
};
return item;
}));
}
/// <summary>
/// Gets the list of Weather UI elements
/// </summary>
/// <returns>A list containing XivUi data</returns>
public List <XivUi> GetWeatherList()
{
var weatherList = new List <XivUi>();
// These are the offsets to relevant data
// These will need to be changed if data gets added or removed with a patch
const int nameLengthOffset = 6;
const int iconNumberOffest = 26;
var ex = new Ex(_gameDirectory, _xivLanguage);
var weatherExData = ex.ReadExData(XivEx.weather);
var weatherNames = new List <string>();
foreach (var weather in weatherExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Weather
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(weather)))
{
br.BaseStream.Seek(nameLengthOffset, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
br.BaseStream.Seek(iconNumberOffest, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.IconNumber = iconNumber;
xivUi.Name = name;
}
if (weatherNames.Contains(xivUi.Name))
{
continue;
}
weatherNames.Add(xivUi.Name);
weatherList.Add(xivUi);
}
weatherList.Sort();
return(weatherList);
}
/// <summary>
/// Gets the list of online status UI elements
/// </summary>
/// <returns>A list containing XivUi data</returns>
public async Task <List <XivUi> > GetOnlineStatusList()
{
var onlineStatusLock = new object();
var onlineStatusList = new List <XivUi>();
// These are the offsets to relevant data
// These will need to be changed if data gets added or removed with a patch
const int iconNumberOffset = 6;
const int dataSize = 12;
var onlineStatusExData = await _ex.ReadExData(XivEx.onlinestatus);
await Task.Run(() => Parallel.ForEach(onlineStatusExData.Values, (onlineStatus) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.OnlineStatus
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(onlineStatus)))
{
br.BaseStream.Seek(iconNumberOffset, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
br.BaseStream.Seek(dataSize, SeekOrigin.Begin);
// The size of the online status name string
// Size of the entire data chunk - size of the data portion
var nameLength = onlineStatus.Length - dataSize;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.IconNumber = iconNumber;
xivUi.Name = name;
}
lock (onlineStatusLock)
{
onlineStatusList.Add(xivUi);
}
}));
onlineStatusList.Sort();
return(onlineStatusList);
}
/// <summary>
/// Gets the list of map symbol UI elements
/// </summary>
/// <remarks>
/// The map symbol exd only contains refrences to the placenamedata exd
/// The names of the symbols are contained withing the placenamedata exd
/// </remarks>
/// <returns>A list containing XivUi data</returns>
public async Task <List <XivUi> > GetMapSymbolList()
{
var mapSymbolLock = new object();
var mapSymbolList = new List <XivUi>();
var mapSymbolExData = await _ex.ReadExData(XivEx.mapsymbol);
var placeNameData = await _ex.ReadExData(XivEx.placename);
await Task.Run(() => Parallel.ForEach(mapSymbolExData.Values, (mapSymbol) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.MapSymbol
};
int placeNameIndex;
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(mapSymbol)))
{
var iconNumber = br.ReadInt32();
placeNameIndex = br.ReadInt32();
if (iconNumber == 0)
{
return;
}
xivUi.IconNumber = iconNumber;
}
// Gets the name of the map symbol from the placename exd
xivUi.Name = GetPlaceName(placeNameData[placeNameIndex]);
if (xivUi.Name.Equals(string.Empty))
{
return;
}
lock (mapSymbolLock)
{
mapSymbolList.Add(xivUi);
}
}));
mapSymbolList.Sort();
return(mapSymbolList);
}
/// <summary>
/// Gets the list of online status UI elements
/// </summary>
/// <returns>A list containing XivUi data</returns>
public List <XivUi> GetOnlineStatusList()
{
var onlineStatusList = new List <XivUi>();
// These are the offsets to relevant data
// These will need to be changed if data gets added or removed with a patch
const int iconNumberOffset = 6;
const int dataSize = 12;
var ex = new Ex(_gameDirectory, _xivLanguage);
var onlineStatusExData = ex.ReadExData(XivEx.onlinestatus);
foreach (var onlineStatus in onlineStatusExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.OnlineStatus
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(onlineStatus)))
{
br.BaseStream.Seek(iconNumberOffset, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
br.BaseStream.Seek(dataSize, SeekOrigin.Begin);
// The size of the online status name string
// Size of the entire data chunk - size of the data portion
var nameLength = onlineStatus.Length - dataSize;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.IconNumber = iconNumber;
xivUi.Name = name;
}
onlineStatusList.Add(xivUi);
}
onlineStatusList.Sort();
return(onlineStatusList);
}
/// <summary>
/// Gets the list of available loading screen images
/// </summary>
/// <returns>A list containing XivUi data</returns>
public async Task <List <XivUi> > GetLoadingImageList()
{
var loadingImageLock = new object();
var loadingImageList = new List <XivUi>();
// These are the offsets to relevant data
// These will need to be changed if data gets added or removed with a patch
const int dataLength = 4;
var loadingImageExData = await _ex.ReadExData(XivEx.loadingimage);
await Task.Run(() => Parallel.ForEach(loadingImageExData.Values, (loadingImage) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.LoadingScreen,
UiPath = "ui/loadingimage"
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(loadingImage)))
{
br.BaseStream.Seek(dataLength, SeekOrigin.Begin);
// The length of the loading image name string
// Size of the entire data chunk - size of the data portion
var nameLength = loadingImage.Length - dataLength;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
if (name.Equals(""))
{
return;
}
xivUi.Name = name;
}
lock (loadingImageLock)
{
loadingImageList.Add(xivUi);
}
}));
loadingImageList.Sort();
return(loadingImageList);
}
/// <summary>
/// Gets the list of map symbol UI elements
/// </summary>
/// <remarks>
/// The map symbol exd only contains refrences to the placenamedata exd
/// The names of the symbols are contained withing the placenamedata exd
/// </remarks>
/// <returns>A list containing XivUi data</returns>
public List <XivUi> GetMapSymbolList()
{
var mapSymbolList = new List <XivUi>();
var ex = new Ex(_gameDirectory, _xivLanguage);
var mapSymbolExData = ex.ReadExData(XivEx.mapsymbol);
var placeNameData = ex.ReadExData(XivEx.placename);
foreach (var mapSymbol in mapSymbolExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.MapSymbol
};
int placeNameIndex;
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(mapSymbol)))
{
var iconNumber = br.ReadInt32();
placeNameIndex = br.ReadInt32();
if (iconNumber == 0)
{
continue;
}
xivUi.IconNumber = iconNumber;
}
// Gets the name of the map symbol from the placename exd
xivUi.Name = GetPlaceName(placeNameData[placeNameIndex]);
if (xivUi.Name.Equals(string.Empty))
{
continue;
}
mapSymbolList.Add(xivUi);
}
mapSymbolList.Sort();
return(mapSymbolList);
}
/// <summary>
/// Gets the list of available loading screen images
/// </summary>
/// <returns>A list containing XivUi data</returns>
public List <XivUi> GetLoadingImageList()
{
var loadingImageList = new List <XivUi>();
// These are the offsets to relevant data
// These will need to be changed if data gets added or removed with a patch
const int dataLength = 4;
var ex = new Ex(_gameDirectory, _xivLanguage);
var loadingImageExData = ex.ReadExData(XivEx.loadingimage);
foreach (var loadingImage in loadingImageExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.LoadingScreen,
UiPath = "ui/loadingimage"
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(loadingImage)))
{
br.BaseStream.Seek(dataLength, SeekOrigin.Begin);
// The length of the loading image name string
// Size of the entire data chunk - size of the data portion
var nameLength = loadingImage.Length - dataLength;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
if (name.Equals(""))
{
continue;
}
xivUi.Name = name;
}
loadingImageList.Add(xivUi);
}
loadingImageList.Sort();
return(loadingImageList);
}
/// <summary>
/// Gets the list of available map data
/// </summary>
/// <remarks>
/// The map data is obtained from the map exd files
/// There may be unlisted maps which this does not check for
/// </remarks>
/// <returns>A list containing XivUi data</returns>
public List <XivUi> GetMapList()
{
// These are the offsets to relevant data
// These will need to be changed if data gets added or removed with a patch
const int regionMapDataOffset = 12;
const int dataLength = 32;
var mapList = new List <XivUi>();
var ex = new Ex(_gameDirectory, _xivLanguage);
var placeNameData = ex.ReadExData(XivEx.placename);
var mapData = ex.ReadExData(XivEx.map);
var mapNameList = new List <string>();
// Loops through all available maps in the map exd files
// At present only one file exists (map_0)
foreach (var map in mapData.Values)
{
int regionIndex;
int mapIndex;
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Maps
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(map)))
{
br.BaseStream.Seek(regionMapDataOffset, SeekOrigin.Begin);
regionIndex = br.ReadInt16();
mapIndex = br.ReadInt16();
if (mapIndex == 0)
{
continue;
}
br.BaseStream.Seek(dataLength, SeekOrigin.Begin);
// The size of the map path string
// Size of the entire data chunk - size of the data portion
var mapPathLength = map.Length - dataLength;
if (mapPathLength < 4)
{
continue;
}
xivUi.UiPath = Encoding.UTF8.GetString(br.ReadBytes(mapPathLength)).Replace("\0", "");
}
// Gets the name from the placename exd file
var regionName = GetPlaceName(placeNameData[regionIndex]);
var mapName = GetPlaceName(placeNameData[mapIndex]);
if (mapName.Equals(string.Empty))
{
continue;
}
xivUi.Name = mapName;
xivUi.ItemSubCategory = regionName;
if (mapNameList.Contains(mapName))
{
xivUi.Name = mapName + " " + xivUi.UiPath.Substring(xivUi.UiPath.Length - 2);
}
mapNameList.Add(mapName);
mapList.Add(xivUi);
}
mapList.Sort();
return(mapList);
}
/// <summary>
/// Gets the list of action UI elements
/// </summary>
/// <remarks>
/// The actions are obtained from different sources, but is not all inclusive
/// There may be some actions that are missing
/// </remarks>
/// <returns>A list containing XivUi data</returns>
public async Task <List <XivUi> > GetActionList()
{
var actionLock = new object();
// Data from the action_0 exd
var actionExData = await _ex.ReadExData(XivEx.action);
var actionCategoryExData = await _ex.ReadExData(XivEx.actioncategory);
var actionList = new List <XivUi>();
var actionNames = new List <string>();
await Task.Run(() => Parallel.ForEach(actionExData.Values, (action) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Actions
};
int actionCategory;
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(8, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
var dataOffset = 28;
var dataLength = 60;
br.BaseStream.Seek(dataOffset, SeekOrigin.Begin);
actionCategory = br.ReadByte();
br.BaseStream.Seek(dataLength, SeekOrigin.Begin);
var nameLength = action.Length - dataLength;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (xivUi.Name.Equals(string.Empty))
{
return;
}
if (actionNames.Contains(xivUi.Name))
{
return;
}
var actionCategoryData = actionCategoryExData[actionCategory];
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(actionCategoryData)))
{
br.BaseStream.Seek(4, SeekOrigin.Begin);
var nameLength = actionCategoryData.Length - 4;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
if (name.Equals(string.Empty))
{
xivUi.TertiaryCategory = XivStrings.None;
}
else
{
xivUi.TertiaryCategory = name;
}
}
lock (actionLock)
{
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
}));
// Data from generalaction_0
var generalActionExData = await _ex.ReadExData(XivEx.generalaction);
await Task.Run(() => Parallel.ForEach(generalActionExData.Values, (action) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Actions,
TertiaryCategory = XivStrings.General
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(6, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
br.BaseStream.Seek(10, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
br.BaseStream.Seek(20, SeekOrigin.Begin);
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
lock (actionLock)
{
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
}));
// Data from buddyaction_0
var buddyActionExData = await _ex.ReadExData(XivEx.buddyaction);
await Task.Run(() => Parallel.ForEach(buddyActionExData.Values, (action) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Actions,
TertiaryCategory = XivStrings.Buddy
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(6, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
br.BaseStream.Seek(10, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
br.BaseStream.Seek(20, SeekOrigin.Begin);
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
return;
}
lock (actionLock)
{
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
}));
// Data from companyaction_0
var companyActionExData = await _ex.ReadExData(XivEx.companyaction);
await Task.Run(() => Parallel.ForEach(companyActionExData.Values, (action) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Actions,
TertiaryCategory = XivStrings.Company
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(6, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
br.BaseStream.Seek(14, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
br.BaseStream.Seek(20, SeekOrigin.Begin);
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
return;
}
lock (actionLock)
{
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
}));
// Data from craftaction_100000
var craftActionExData = await _ex.ReadExData(XivEx.craftaction);
await Task.Run(() => Parallel.ForEach(craftActionExData.Values, (action) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Actions,
TertiaryCategory = XivStrings.Craft
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(6, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
br.BaseStream.Seek(48, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
br.BaseStream.Seek(60, SeekOrigin.Begin);
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
return;
}
lock (actionLock)
{
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
}));
// Data from eventaction_0
var eventActionExData = await _ex.ReadExData(XivEx.eventaction);
await Task.Run(() => Parallel.ForEach(eventActionExData.Values, (action) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Actions,
TertiaryCategory = XivStrings.Event
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(4, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
br.BaseStream.Seek(16, SeekOrigin.Begin);
var nameLength = action.Length - 16;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
return;
}
lock (actionLock)
{
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
}));
// Data from emote_0
var emoteExData = await _ex.ReadExData(XivEx.emote);
await Task.Run(() => Parallel.ForEach(emoteExData.Values, (action) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Actions,
TertiaryCategory = XivStrings.Emote
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(28, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
br.BaseStream.Seek(40, SeekOrigin.Begin);
var nameLength = action.Length - 40;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
return;
}
lock (actionLock)
{
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
}));
// Data from marker_0
var markerExData = await _ex.ReadExData(XivEx.marker);
await Task.Run(() => Parallel.ForEach(markerExData.Values, (action) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Actions,
TertiaryCategory = XivStrings.Marker
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(6, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
var nameLength = action.Length - 6;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
return;
}
lock (actionLock)
{
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
}));
// Data from fieldmarker_0
var fieldMarkerExData = await _ex.ReadExData(XivEx.fieldmarker);
await Task.Run(() => Parallel.ForEach(fieldMarkerExData.Values, (action) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Actions,
TertiaryCategory = XivStrings.FieldMarker
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(8, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
br.BaseStream.Seek(12, SeekOrigin.Begin);
var nameLength = action.Length - 12;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
return;
}
lock (actionLock)
{
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
}));
actionList.Sort();
return(actionList);
}
/// <summary>
/// Gets the list of status effect UI elements
/// </summary>
/// <returns>A list containing XivUi data</returns>
public async Task <List <XivUi> > GetStatusList()
{
var statusLock = new object();
var statusList = new List <XivUi>();
// These are the offsets to relevant data
// These will need to be changed if data gets added or removed with a patch
const int nameLengthDataOffset = 6;
var typeDataOffset = 13;
var dataLength = 24;
if (_xivLanguage != XivLanguage.Korean)
{
typeDataOffset = 16;
dataLength = 28;
}
var statusExData = await _ex.ReadExData(XivEx.status);
await Task.Run(() => Parallel.ForEach(statusExData.Values, (status) =>
{
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Status
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(status)))
{
br.BaseStream.Seek(nameLengthDataOffset, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
return;
}
br.BaseStream.Seek(typeDataOffset, SeekOrigin.Begin);
var type = br.ReadByte();
br.BaseStream.Seek(dataLength, SeekOrigin.Begin);
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.IconNumber = iconNumber;
xivUi.Name = name;
if (name.Equals(string.Empty))
{
return;
}
//Status effects have a byte that determines whether the effect is detrimental or beneficial
if (type == 1)
{
xivUi.TertiaryCategory = XivStrings.Beneficial;
}
else if (type == 2)
{
xivUi.TertiaryCategory = XivStrings.Detrimental;
}
else
{
xivUi.TertiaryCategory = XivStrings.None;
xivUi.Name = xivUi.Name + " " + type;
}
}
lock (statusLock)
{
statusList.Add(xivUi);
}
}));
statusList.Sort();
return(statusList);
}
/// <summary>
/// Gets the list of status effect UI elements
/// </summary>
/// <returns>A list containing XivUi data</returns>
public List <XivUi> GetStatusList()
{
var statusList = new List <XivUi>();
// These are the offsets to relevant data
// These will need to be changed if data gets added or removed with a patch
const int nameLengthDataOffset = 6;
const int typeDataOffset = 13;
const int dataLength = 24;
var ex = new Ex(_gameDirectory, _xivLanguage);
var statusExData = ex.ReadExData(XivEx.status);
foreach (var status in statusExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Status
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(status)))
{
br.BaseStream.Seek(nameLengthDataOffset, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
br.BaseStream.Seek(typeDataOffset, SeekOrigin.Begin);
var type = br.ReadByte();
br.BaseStream.Seek(dataLength, SeekOrigin.Begin);
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.IconNumber = iconNumber;
xivUi.Name = name;
if (name.Equals(string.Empty))
{
continue;
}
//Status effects have a byte that determines whether the effect is detrimental or beneficial
if (type == 1)
{
xivUi.ItemSubCategory = XivStrings.Beneficial;
}
else if (type == 2)
{
xivUi.ItemSubCategory = XivStrings.Detrimental;
}
else
{
xivUi.ItemSubCategory = XivStrings.None;
xivUi.Name = xivUi.Name + " " + type;
}
}
statusList.Add(xivUi);
}
statusList.Sort();
return(statusList);
}
/// <summary>
/// Gets the list of available map data
/// </summary>
/// <remarks>
/// The map data is obtained from the map exd files
/// There may be unlisted maps which this does not check for
/// </remarks>
/// <returns>A list containing XivUi data</returns>
public async Task <List <XivUi> > GetMapList()
{
var mapLock = new object();
// These are the offsets to relevant data
// These will need to be changed if data gets added or removed with a patch
const int regionMapDataOffset = 12;
const int dataLength = 32;
var mapList = new List <XivUi>();
var placeNameData = await _ex.ReadExData(XivEx.placename);
var mapData = await _ex.ReadExData(XivEx.map);
var mapNameList = new List <string>();
// Loops through all available maps in the map exd files
// At present only one file exists (map_0)
await Task.Run(() => Parallel.ForEach(mapData.Values, (map) =>
{
int regionIndex;
int mapIndex;
var xivUi = new XivUi()
{
PrimaryCategory = "UI",
SecondaryCategory = XivStrings.Maps
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(map)))
{
br.BaseStream.Seek(regionMapDataOffset, SeekOrigin.Begin);
regionIndex = br.ReadInt16();
mapIndex = br.ReadInt16();
if (mapIndex == 0)
{
return;
}
br.BaseStream.Seek(dataLength, SeekOrigin.Begin);
// The size of the map path string
// Size of the entire data chunk - size of the data portion
var mapPathLength = map.Length - dataLength;
if (mapPathLength < 4)
{
return;
}
xivUi.UiPath = Encoding.UTF8.GetString(br.ReadBytes(mapPathLength)).Replace("\0", "");
}
// Gets the name from the placename exd file
var regionName = GetPlaceName(placeNameData[regionIndex]);
var mapName = GetPlaceName(placeNameData[mapIndex]);
if (mapName.Equals(string.Empty))
{
return;
}
xivUi.Name = mapName;
xivUi.TertiaryCategory = regionName;
if (mapNameList.Contains(mapName))
{
xivUi.Name = mapName + " " + xivUi.UiPath.Substring(xivUi.UiPath.Length - 2);
}
lock (mapLock)
{
mapNameList.Add(mapName);
mapList.Add(xivUi);
}
}));
mapList.Sort();
return(mapList);
}
/// <summary>
/// Gets the list of action UI elements
/// </summary>
/// <remarks>
/// The actions are obtained from different sources, but is not all inclusive
/// There may be some actions that are missing
/// </remarks>
/// <returns>A list containing XivUi data</returns>
public List <XivUi> GetActionList()
{
var ex = new Ex(_gameDirectory, _xivLanguage);
// Data from the action_0 exd
var actionExData = ex.ReadExData(XivEx.action);
var actionCategoryExData = ex.ReadExData(XivEx.actioncategory);
var actionList = new List <XivUi>();
var actionNames = new List <string>();
foreach (var action in actionExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Actions
};
int actionCategory;
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(8, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
br.BaseStream.Seek(26, SeekOrigin.Begin);
actionCategory = br.ReadByte();
br.BaseStream.Seek(56, SeekOrigin.Begin);
var nameLength = action.Length - 56;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
continue;
}
actionNames.Add(xivUi.Name);
var actionCategoryData = actionCategoryExData[actionCategory];
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(actionCategoryData)))
{
br.BaseStream.Seek(4, SeekOrigin.Begin);
var nameLength = actionCategoryData.Length - 4;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
if (name.Equals(string.Empty))
{
xivUi.ItemSubCategory = XivStrings.None;
}
else
{
xivUi.ItemSubCategory = name;
}
}
actionList.Add(xivUi);
}
// Data from generalaction_0
var generalActionExData = ex.ReadExData(XivEx.generalaction);
foreach (var action in generalActionExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Actions,
ItemSubCategory = XivStrings.General
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(8, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
br.BaseStream.Seek(10, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
br.BaseStream.Seek(20, SeekOrigin.Begin);
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
continue;
}
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
// Data from buddyaction_0
var buddyActionExData = ex.ReadExData(XivEx.buddyaction);
foreach (var action in buddyActionExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Actions,
ItemSubCategory = XivStrings.Buddy
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(6, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
br.BaseStream.Seek(10, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
br.BaseStream.Seek(20, SeekOrigin.Begin);
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
continue;
}
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
// Data from companyaction_0
var companyActionExData = ex.ReadExData(XivEx.companyaction);
foreach (var action in companyActionExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Actions,
ItemSubCategory = XivStrings.Company
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(6, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
br.BaseStream.Seek(14, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
br.BaseStream.Seek(20, SeekOrigin.Begin);
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
continue;
}
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
// Data from craftaction_100000
var craftActionExData = ex.ReadExData(XivEx.craftaction);
foreach (var action in craftActionExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Actions,
ItemSubCategory = XivStrings.Craft
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(6, SeekOrigin.Begin);
var nameLength = br.ReadInt16();
br.BaseStream.Seek(48, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
br.BaseStream.Seek(60, SeekOrigin.Begin);
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
continue;
}
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
// Data from eventaction_0
var eventActionExData = ex.ReadExData(XivEx.eventaction);
foreach (var action in eventActionExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Actions,
ItemSubCategory = XivStrings.Event
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(4, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
br.BaseStream.Seek(16, SeekOrigin.Begin);
var nameLength = action.Length - 16;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
continue;
}
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
// Data from emote_0
var emoteExData = ex.ReadExData(XivEx.emote);
foreach (var action in emoteExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Actions,
ItemSubCategory = XivStrings.Emote
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(26, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
br.BaseStream.Seek(36, SeekOrigin.Begin);
var nameLength = action.Length - 36;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
continue;
}
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
// Data from marker_0
var markerExData = ex.ReadExData(XivEx.marker);
foreach (var action in markerExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Actions,
ItemSubCategory = XivStrings.Marker
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(6, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
var nameLength = action.Length - 6;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
continue;
}
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
// Data from fieldmarker_0
var fieldMarkerExData = ex.ReadExData(XivEx.fieldmarker);
foreach (var action in fieldMarkerExData.Values)
{
var xivUi = new XivUi()
{
Category = "UI",
ItemCategory = XivStrings.Actions,
ItemSubCategory = XivStrings.FieldMarker
};
// Big Endian Byte Order
using (var br = new BinaryReaderBE(new MemoryStream(action)))
{
br.BaseStream.Seek(8, SeekOrigin.Begin);
var iconNumber = br.ReadUInt16();
if (iconNumber == 0)
{
continue;
}
br.BaseStream.Seek(12, SeekOrigin.Begin);
var nameLength = action.Length - 12;
var name = Encoding.UTF8.GetString(br.ReadBytes(nameLength)).Replace("\0", "");
xivUi.Name = name;
xivUi.IconNumber = iconNumber;
}
if (actionNames.Contains(xivUi.Name))
{
continue;
}
actionNames.Add(xivUi.Name);
actionList.Add(xivUi);
}
actionList.Sort();
return(actionList);
}
