Server Exports

GetPlayerActivePet

Description: Returns the network ID (netId) of the player's currently summoned pet entity (0 when none).

Signature:

local netId = exports["hoff-battlebuddies"]:GetPlayerActivePet(source)

Returns:

• netId (number): network id for the player's active pet or 0 if none

Example:

local petNetId = exports["hoff-battlebuddies"]:GetPlayerActivePet(targetSrc)
if petNetId and petNetId ~= 0 then
	-- do something with the active pet's net id
end

GetPlayerActivePetId

Description: Returns the player's currently active PetId (journal identifier) or nil if none.

Signature:

local petId = exports["hoff-battlebuddies"]:GetPlayerActivePetId(source)

Returns:

• petId (string|nil): the PetId string from the player's profile or nil

Example:

local petId = exports["hoff-battlebuddies"]:GetPlayerActivePetId(targetSrc)
if petId then print("Active pet id:", petId) end

DismissPetFor

Description: Force-dismiss the specified player's summoned pet. Optionally pushes a journal update to their UI.

Signature:

exports["hoff-battlebuddies"]:DismissPetFor(source, pushUI)

HideFollowerPetFor

Description: Temporarily hides the player's follower pet by moving it to a hidden routing bucket so other players won't see it.

Signature:

exports["hoff-battlebuddies"]:HideFollowerPetFor(source)

UnhideFollowerPetFor

Description: Restore a previously hidden follower pet back into the player's routing bucket so it becomes visible again.

Signature:

exports["hoff-battlebuddies"]:UnhideFollowerPetFor(source)

AddBattlePetToPlayer

Description: Programmatically add a new battle pet record to a player's profile. Accepts raw tables or battle pet instances — the persistence module will normalize and persist the pet.

Signature:

local ok = exports["hoff-battlebuddies"]:AddBattlePetToPlayer(source, battlePetTable)

Returns:

• ok (boolean): true when add/save succeeded

Example:

local ok = exports["hoff-battlebuddies"]:AddBattlePetToPlayer(targetSrc, {
	SpeciesId = "pug",
	Level = 1,
	Nickname = "Buddy",
})

RemoveBattlePetFromPlayer

Description: Remove a battle pet from a player's profile by PetId (permanent removal).

Signature:

local ok = exports["hoff-battlebuddies"]:RemoveBattlePetFromPlayer(source, petId)

Returns:

• ok (boolean): true on success

Example:

local ok = exports["hoff-battlebuddies"]:RemoveBattlePetFromPlayer(targetSrc, "pet_xxx123")

GetPlayerProfile

Description: Return the server-side cached profile object for a player (pets, team order, active pet id, TrainerWins, etc.). Useful for server logic that needs read/write access to a player's pet data.

Signature:

local profile = exports["hoff-battlebuddies"]:GetPlayerProfile(source)

Returns:

• profile (table): the raw profile table stored/cached for the player

Example:

local profile = exports["hoff-battlebuddies"]:GetPlayerProfile(targetSrc)

GetPetInstance

Description: Return a server-side Class.BattlePet instance (if available) for the given player + PetId. Useful when you need class helpers / methods for a pet.

Signature:

local inst = exports["hoff-battlebuddies"]:GetPetInstance(source, petId)

Returns:

• inst (table|nil): Class.BattlePet instance or nil when unavailable

Example:

local inst = exports["hoff-battlebuddies"]:GetPetInstance(targetSrc, "pet_xxx123")
if inst then inst:UpdateStats() end

SavePlayerProfile

Description: Persist the provided profile back to storage (JSON or MySQL depending on configuration). Updates caches accordingly.

Signature:

local ok = exports["hoff-battlebuddies"]:SavePlayerProfile(source, profile)

Returns:

• ok (boolean): true on successful save

HasBeatenTrainer

Description: Check whether a player has already defeated the given trainer (one-time completion flag).

Signature:

local beaten = exports["hoff-battlebuddies"]:HasBeatenTrainer(source, trainerId)

Returns:

• beaten (boolean): true when the trainer id is recorded as beaten for the player

Example:

if exports["hoff-battlebuddies"]:HasBeatenTrainer(targetSrc, "trainer_joe") then
	print("Trainer Joe already beaten")
end

MarkTrainerBeaten

Description: Mark a trainer as beaten for the player and persist the change.

Signature:

local ok = exports["hoff-battlebuddies"]:MarkTrainerBeaten(source, trainerId)

Returns:

• ok (boolean): true if the state changed and the profile saved

Example:

exports["hoff-battlebuddies"]:MarkTrainerBeaten(targetSrc, "trainer_joe")