README.md

Hardstuck BuildCodes V2 - PHP 8.0 implementation

There is an autoloader available:

require_once 'include/php/8.0/autoload.php';

There are multiple ways to obtain a Hardstuck BuildCode Object:

Some of these functions require to call PerProfessionData::Reload[All]() first or set PerProfessionData::LazyLoadMode to a value other than NONE.

use Hardstuck\GuildWars2\BuildCodes\V2\TextLoader;

// From existing build textual codes:
$code1 = TextLoader::LoadBuildCode("CoI___~______A~M~__A_");

// From existing textual in-game chatlinks:
$inGameLink = "[&DQkAAAAARQDcEdwRAAAAACsSAADUEQAAAAAAAAQCAwDUESsSAAAAAAAAAAA=]";
$code3 = TextLoader::LoadOfficialBuildCode($inGameLink);

use Hardstuck\GuildWars2\BuildCodes\V2\BinaryLoader;

// From existing binary in-game chatlink data:
$inGameLink = "[&DQkAAAAARQDcEdwRAAAAACsSAADUEQAAAAAAAAQCAwDUESsSAAAAAAAAAAA=]";
$rawInGameBytes = base64_decode(substring($inGameLink, 2, strlen($inGameLink) - 3));
$code4 = BinaryLoader::LoadOfficialBuildCode($rawInGameBytes);

use Hardstuck\GuildWars2\BuildCodes\V2\APILoader;

// From an existing player via the official api:
$apiKey = "AD041D99-AEEF...";
$characterName = "Don Joe Was Taken";
$code5 = APILoader::LoadBuildCode($apiKey, $characterName, Kind::PvE);

From this Object different kinds of codes can be generated:

use Hardstuck\GuildWars2\BuildCodes\V2\TextLoader;
use Hardstuck\GuildWars2\BuildCodes\V2\BinaryLoader;

$code = SomeSource();

// To a textual version of the Hardstuck BuildCode
$hsCode = TextLoader::WriteBuildCode($code);

// To a compressed binary version of the Hardstuck BuildCode
$buffer = BinaryLoader::WriteBuildCode($code);

// Directly to a full in-game chat link
$chatLink = TextLoader::WriteOfficialBuildCode($code);

// To the raw data of an in-game chat link
$buffer = BinaryLoader::WriteOfficialBuildCode($code);

There are multiple overloads available for most of those operations.

Other utility functions available:

Static::IsTwoHanded(int $weapon) : boolean;
Static::IsAquatic(int $weapon) : Tristate;
Static::ResolveEffectiveWeapons(BuildCode $code, int $set) : WeaponSet;
Static::ResolveDummyItemForWeaponType(int $weaponType, int $statId) : int;
Static::ResolveDummyItemForEquipment(int $equipmentIndex, int $weightClass, int $statId) : int;
Static::ResolveWeightClass(int $profession) : int;

APICache::ResolveWeaponType(int $itemId) : int;
APICache::ResolveStatId(int $itemId) : int;
APICache::ResolvePosition(int? $traitId) : int;
APICache::ResolveWeaponSkill(BuildCode $code, WeaponSet $effectiveWeapons, int $skillIndex) : int;
APICache::ResolveTrait(int $spec, int $traitSlot) : int;