landsandboat/scripts/specs/core/CBaseEntity.lua

4265 lines
79 KiB
Lua
Raw Permalink Normal View History

---@meta
-- luacheck: ignore 241
---@class CBaseEntity
local CBaseEntity = {}
---@param mob CBaseEntity
---@param messageID integer
---@param p0 integer?
---@param p1 integer?
---@param p2 integer?
---@param p3 integer?
---@param showName boolean?
---@param turn boolean?
---@return nil
function CBaseEntity:showText(mob, messageID, p0, p1, p2, p3, showName, turn)
end
---@param PLuaBaseEntity CBaseEntity
---@param messageID integer
---@param arg2 boolean|integer|table?
---@param arg3 integer?
---@return nil
function CBaseEntity:messageText(PLuaBaseEntity, messageID, arg2, arg3)
end
---@param message string
---@param messageTypeObj integer?
---@param nameObj string?
---@return nil
function CBaseEntity:printToPlayer(message, messageTypeObj, nameObj)
end
---@param message string Message to send
---@param arg1 integer? Message Type
---@param arg2 integer? Message Range
2025-03-27 12:30:35 +00:00
---@param arg3 string? Name
---@param arg4 boolean? Skip sender
---@return nil
2025-03-27 12:30:35 +00:00
function CBaseEntity:printToArea(message, arg1, arg2, arg3, arg4)
end
---@param messageID integer
---@param p0 integer?
---@param p1 integer?
---@param target CBaseEntity?
---@return nil
function CBaseEntity:messageBasic(messageID, p0, p1, target)
end
---@param messageID integer
---@param entity CBaseEntity?
---@param p0 integer?
---@param p1 integer?
---@param p2 integer?
---@param p3 integer?
---@param chat integer?
---@return nil
function CBaseEntity:messageName(messageID, entity, p0, p1, p2, p3, chat)
end
---@param messageID integer
---@param PEntity CBaseEntity
---@param arg2 integer?
---@param arg3 integer?
---@return nil
function CBaseEntity:messagePublic(messageID, PEntity, arg2, arg3)
end
---@param messageID integer
---@param param0 integer?
---@param param1 integer?
---@param param2 integer?
---@param param3 integer?
---@param showName boolean?
---@return nil
function CBaseEntity:messageSpecial(messageID, param0, param1, param2, param3, showName)
end
---@param messageID integer
---@param p0 integer?
---@param p1 integer?
---@return nil
function CBaseEntity:messageSystem(messageID, p0, p1)
end
---@param speaker CBaseEntity?
---@param p0 integer
---@param p1 integer
---@param message xi.msg.basic
---@return nil
function CBaseEntity:messageCombat(speaker, p0, p1, message)
end
---@param messageID integer
---@return nil
function CBaseEntity:messageStandard(messageID)
end
---@param obj table
---@return nil
function CBaseEntity:customMenu(obj)
end
---@nodiscard
---@param varName string
---@return integer
function CBaseEntity:getCharVar(varName)
end
---@nodiscard
---@param varName string
---@return integer
function CBaseEntity:getVar(varName)
end
---@param prefix string
---@return table
function CBaseEntity:getCharVarsWithPrefix(prefix)
end
---@param varName string
---@param value integer
---@param expiry integer?
---@return nil
function CBaseEntity:setCharVar(varName, value, expiry)
end
---@param varName string
---@param value integer
---@param expiry integer?
---@return nil
function CBaseEntity:setVar(varName, value, expiry)
end
---@param varName string
---@param expiry integer
---@return nil
function CBaseEntity:setCharVarExpiration(varName, expiry)
end
---@param varname string
---@param value integer
---@return nil
function CBaseEntity:incrementCharVar(varname, value)
end
---@param varName string
---@param value integer
---@param expiry integer?
---@return nil
function CBaseEntity:setVolatileCharVar(varName, value, expiry)
end
---@nodiscard
---@return table
function CBaseEntity:getLocalVars()
end
---@nodiscard
---@param var string
---@return integer
function CBaseEntity:getLocalVar(var)
end
---@param var string
---@param val integer
---@return nil
function CBaseEntity:setLocalVar(var, val)
end
---@return nil
function CBaseEntity:resetLocalVars()
end
---@param prefix string
---@return nil
function CBaseEntity:clearVarsWithPrefix(prefix)
end
---@nodiscard
---@return integer
function CBaseEntity:getLastOnline()
end
---@param filename string
---@return nil
function CBaseEntity:injectPacket(filename)
end
---@param inTargetID integer
---@param inCategory integer
---@param inAnimationID integer
---@param inSpecEffect integer
---@param inReaction integer
---@param inMessage integer
---@param inActionParam integer
---@param inParam integer
---@return nil
function CBaseEntity:injectActionPacket(inTargetID, inCategory, inAnimationID, inSpecEffect, inReaction, inMessage, inActionParam, inParam)
end
---@param command string
---@param entity CBaseEntity?
---@return nil
function CBaseEntity:entityVisualPacket(command, entity)
end
---@param command string
---@param target CBaseEntity?
---@return nil
function CBaseEntity:entityAnimationPacket(command, target)
end
---@param packetData table
---@return nil
function CBaseEntity:sendDebugPacket(packetData)
end
---@param EventID integer
---@param paramTable table
---@return nil
function CBaseEntity:startEvent(EventID, paramTable)
end
---@param EventID integer
---@param p0 integer?
---@param p1 integer?
---@param p2 integer?
---@param p3 integer?
---@param p4 integer?
---@param p5 integer?
---@param p6 integer?
---@param p7 integer?
---@param textTable integer?
function CBaseEntity:startEvent(EventID, p0, p1, p2, p3, p4, p5, p6, p7, textTable)
end
---@param EventID integer
---@param string1 string
---@param string2 string
---@param string3 string
---@param string4 string
---@param op1 integer?
---@param op2 integer?
---@param op3 integer?
---@param op4 integer?
---@param op5 integer?
---@param op6 integer?
---@param op7 integer?
---@param op8 integer?
---@return nil
function CBaseEntity:startEventString(EventID, string1, string2, string3, string4, op1, op2, op3, op4, op5, op6, op7, op8)
end
---@param EventID integer
---@param paramTable table
---@return nil
function CBaseEntity:startCutscene(EventID, paramTable)
end
---@param EventID integer
---@param p0 integer?
---@param p1 integer?
---@param p2 integer?
---@param p3 integer?
---@param p4 integer?
---@param p5 integer?
---@param p6 integer?
---@param p7 integer?
---@param textTable integer?
function CBaseEntity:startCutscene(EventID, p0, p1, p2, p3, p4, p5, p6, p7, textTable)
end
---@param EventID integer
---@param paramTable table
---@return nil
function CBaseEntity:startOptionalCutscene(EventID, paramTable)
end
---@param EventID integer
---@param p0 integer?
---@param p1 integer?
---@param p2 integer?
---@param p3 integer?
---@param p4 integer?
---@param p5 integer?
---@param p6 integer?
---@param p7 integer?
---@param textTable integer?
function CBaseEntity:startOptionalCutscene(EventID, p0, p1, p2, p3, p4, p5, p6, p7, textTable)
end
---@param ... integer|table?
---@return nil
function CBaseEntity:updateEvent(...)
end
---@param string1 string?
---@param string2 string?
---@param string3 string?
---@param string4 string?
---@param op1 integer?
---@param op2 integer?
---@param op3 integer?
---@param op4 integer?
---@param op5 integer?
---@param op6 integer?
---@param op7 integer?
---@param op8 integer?
---@return nil
function CBaseEntity:updateEventString(string1, string2, string3, string4, op1, op2, op3, op4, op5, op6, op7, op8)
end
---@nodiscard
---@return CBaseEntity?
function CBaseEntity:getEventTarget()
end
---@nodiscard
---@return boolean
function CBaseEntity:isInEvent()
end
---@return nil
function CBaseEntity:release()
end
---@return boolean
function CBaseEntity:startSequence()
end
---@nodiscard
---@return boolean
function CBaseEntity:didGetMessage()
end
---@return nil
function CBaseEntity:resetGotMessage()
end
---@deprecated
function CBaseEntity:setFlag(flags)
end
---@nodiscard
---@return integer
function CBaseEntity:getMoghouseFlag()
end
---@param flag integer
---@return nil
function CBaseEntity:setMoghouseFlag(flag)
end
---@param arg0 boolean? If set, changes loc.zoning to the value provided.
---@return boolean
function CBaseEntity:needToZone(arg0)
end
---@nodiscard
---@return integer
function CBaseEntity:getID()
end
---@nodiscard
---@return integer
function CBaseEntity:getTargID()
end
---@nodiscard
---@return CBaseEntity?
function CBaseEntity:getCursorTarget()
end
---@nodiscard
---@return integer
function CBaseEntity:getObjType()
end
---@nodiscard
---@return boolean
function CBaseEntity:isPC()
end
---@nodiscard
---@return boolean
function CBaseEntity:isNPC()
end
---@nodiscard
---@return boolean
function CBaseEntity:isMob()
end
---@nodiscard
---@return boolean
function CBaseEntity:isPet()
end
---@nodiscard
---@return boolean
function CBaseEntity:isTrust()
end
---@nodiscard
---@return boolean
function CBaseEntity:isAlly()
end
---@return nil
function CBaseEntity:initNpcAi()
end
---@return nil
function CBaseEntity:resetAI()
end
---@nodiscard
---@return integer
function CBaseEntity:getStatus()
end
---@param status integer
---@return nil
function CBaseEntity:setStatus(status)
end
---@nodiscard
---@return integer
function CBaseEntity:getCurrentAction()
end
---@nodiscard
---@return boolean
function CBaseEntity:canUseAbilities()
end
---@param arg0 number
---@param arg1 number
---@param arg2 number
---@return nil
function CBaseEntity:lookAt(arg0, arg1, arg2)
end
---@param posTable table
---@return nil
function CBaseEntity:lookAt(posTable)
end
---@param PLuaBaseEntity CBaseEntity
---@param nonGlobal boolean?
---@return nil
function CBaseEntity:facePlayer(PLuaBaseEntity, nonGlobal)
end
---@return nil
function CBaseEntity:clearTargID()
end
---@nodiscard
---@param arg0 number
---@param arg1 number
---@param arg2 number
---@return boolean
function CBaseEntity:atPoint(arg0, arg1, arg2)
end
---@nodiscard
---@param pointsTable table
---@return boolean
function CBaseEntity:atPoint(pointsTable)
end
---@param x number
---@param y number
---@param z number
---@param flags integer?
function CBaseEntity:pathTo(x, y, z, flags)
end
---@param pointsTable table
---@param flagsObj integer?
---@return boolean
function CBaseEntity:pathThrough(pointsTable, flagsObj)
end
---@nodiscard
---@return boolean
function CBaseEntity:isFollowingPath()
end
---@param pauseObj boolean?
---@return nil
function CBaseEntity:clearPath(pauseObj)
end
---@return nil
function CBaseEntity:continuePath()
end
---@nodiscard
---@param arg0 number|table|CBaseEntity
---@param arg1 number
---@param arg2 number
---@return number
function CBaseEntity:checkDistance(arg0, arg1, arg2)
end
---@nodiscard
---@param posTable table
---@return number
function CBaseEntity:checkDistance(posTable)
end
---@nodiscard
---@param targetEntity CBaseEntity
---@return number
function CBaseEntity:checkDistance(targetEntity)
end
---@param milliseconds integer?
---@return nil
function CBaseEntity:wait(milliseconds)
end
---@param target CBaseEntity
---@param followType integer
---@return nil
function CBaseEntity:follow(target, followType)
end
---@return boolean
function CBaseEntity:hasFollowTarget()
end
---@return nil
function CBaseEntity:unfollow()
end
---@deprecated
function CBaseEntity:WarpTo()
end
---@deprecated
function CBaseEntity:RoamAround()
end
---@deprecated
function CBaseEntity:LimitDistance()
end
---@param careful boolean
---@return nil
function CBaseEntity:setCarefulPathing(careful)
end
---@nodiscard
---@param target CBaseEntity
---@return boolean
function CBaseEntity:canSee(target)
end
---@nodiscard
---@return boolean
function CBaseEntity:inWater()
end
---@param seconds integer?
---@return nil
function CBaseEntity:openDoor(seconds)
end
---@param seconds integer?
---@return nil
function CBaseEntity:closeDoor(seconds)
end
---@param id integer
---@param lowerDoor integer
---@param upperDoor integer
---@param elevatorId integer
---@param reversed boolean
---@return nil
function CBaseEntity:setElevator(id, lowerDoor, upperDoor, elevatorId, reversed)
end
---@param id integer
---@param period integer
---@param minOffset integer
---@return nil
function CBaseEntity:addPeriodicTrigger(id, period, minOffset)
end
---@param seconds integer?
---@return nil
function CBaseEntity:showNPC(seconds)
end
---@param seconds integer?
---@return nil
function CBaseEntity:hideNPC(seconds)
end
---@param seconds integer?
---@return nil
function CBaseEntity:updateNPCHideTime(seconds)
end
---@nodiscard
---@param ignoreScholar boolean?
---@return integer
function CBaseEntity:getWeather(ignoreScholar)
end
---@param weatherType integer
---@return nil
function CBaseEntity:setWeather(weatherType)
end
---@param blockID integer
---@param musicTrackID integer
---@return nil
function CBaseEntity:changeMusic(blockID, musicTrackID)
end
---@param menu xi.menuType
---@return nil
function CBaseEntity:sendMenu(menu)
end
---@nodiscard
---@param guildID integer
---@param open integer
---@param close integer
---@param holiday integer
---@return boolean
function CBaseEntity:sendGuild(guildID, open, close, holiday)
end
2026-06-10 10:22:01 -06:00
---@nodiscard
---@param npc CBaseEntity
---@param open integer
---@param close integer
---@return boolean
function CBaseEntity:openGuildShop(npc, open, close)
end
---@return nil
function CBaseEntity:clearGuildShop()
end
---@param open integer
---@param close integer
---@return nil
function CBaseEntity:sendGuildClose(open, close)
end
---@return nil
function CBaseEntity:openSendBox()
end
---@return nil
function CBaseEntity:leaveGame()
end
---@param target CBaseEntity
---@param emID integer
---@param emMode integer
---@param othersOnly boolean
---@return nil
function CBaseEntity:sendEmote(target, emID, emMode, othersOnly)
end
---@nodiscard
---@param target CBaseEntity
---@param degrees integer?
---@return integer
function CBaseEntity:getWorldAngle(target, degrees)
end
---@nodiscard
---@param posX number
---@param posY number
---@param posZ number
---@return integer
function CBaseEntity:getWorldAngle(posX, posY, posZ)
end
---@nodiscard
---@param target CBaseEntity
---@return integer
function CBaseEntity:getFacingAngle(target)
end
---@nodiscard
---@param target CBaseEntity
---@param angleArg integer?
---@return boolean
function CBaseEntity:isFacing(target, angleArg)
end
---@nodiscard
---@param target CBaseEntity
---@param angleArg integer?
---@return boolean
function CBaseEntity:isInfront(target, angleArg)
end
---@nodiscard
---@param target CBaseEntity
---@param angleArg integer?
---@return boolean
function CBaseEntity:isBehind(target, angleArg)
end
---@nodiscard
---@param target CBaseEntity
---@param angleArg integer?
---@return boolean
function CBaseEntity:isBeside(target, angleArg)
end
---@nodiscard
---@param arg0 boolean? Parameter will return player's destination zone if they are in the process of zoning (for use in onZoneIn)
---@return CZone?
function CBaseEntity:getZone(arg0)
end
---@nodiscard
---@return xi.zone
function CBaseEntity:getZoneID()
end
---@nodiscard
---@return string
function CBaseEntity:getZoneName()
end
---@nodiscard
---@param zone xi.zone
---@return boolean
function CBaseEntity:hasVisitedZone(zone)
end
---@nodiscard
---@return xi.zone
function CBaseEntity:getPreviousZone()
end
2025-10-21 18:40:40 +01:00
---@nodiscard
---@return integer
function CBaseEntity:getPreviousZoneLineID()
end
---@nodiscard
---@return integer
function CBaseEntity:getCurrentRegion()
end
---@nodiscard
---@return integer
function CBaseEntity:getContinentID()
end
---@nodiscard
---@return boolean
function CBaseEntity:inMogHouse()
end
2025-02-03 20:22:45 -05:00
---@param triggerAreaId integer
---@return boolean
function CBaseEntity:isPlayerInTriggerArea(triggerAreaId)
end
---@return nil
function CBaseEntity:isPlayerInAnyTriggerArea()
end
---@param triggerAreaId integer
---@return nil
function CBaseEntity:onPlayerTriggerAreaEnter(triggerAreaId)
end
---@param triggerAreaId integer
---@return nil
function CBaseEntity:onPlayerTriggerAreaLeave(triggerAreaId)
end
---@return nil
function CBaseEntity:clearPlayerTriggerAreas()
end
---@param statusID integer
---@param animation integer
---@param matchTime boolean?
---@return nil
function CBaseEntity:updateToEntireZone(statusID, animation, matchTime)
end
---@param entityToUpdate CBaseEntity
---@param entityUpdate integer
---@param updateMask integer
---@return nil
function CBaseEntity:sendEntityUpdateToPlayer(entityToUpdate, entityUpdate, updateMask)
end
---@param entityToUpdate CBaseEntity
---@return nil
function CBaseEntity:sendEmptyEntityUpdateToPlayer(entityToUpdate)
end
---@return nil
function CBaseEntity:forceRezone()
end
---@return nil
function CBaseEntity:forceLogout()
end
---@nodiscard
---@return table
function CBaseEntity:getPos()
end
---@return nil
function CBaseEntity:showPosition()
end
---@nodiscard
---@return integer
function CBaseEntity:getXPos()
end
---@nodiscard
---@return integer
function CBaseEntity:getYPos()
end
---@nodiscard
---@return integer
function CBaseEntity:getZPos()
end
---@nodiscard
---@return integer
function CBaseEntity:getRotPos()
end
---@param rotation integer
---@return nil
function CBaseEntity:setRotation(rotation)
end
---@param x number?
---@param y number?
---@param z number?
---@param rot integer?
---@param zoneId integer?
---@return nil
function CBaseEntity:setPos(x, y, z, rot, zoneId)
end
---@param posTable table
---@return nil
function CBaseEntity:setPos(posTable)
end
---@return nil
function CBaseEntity:warp()
end
---@param pos table
---@param arg1 integer|CBaseEntity?
---@return nil
function CBaseEntity:teleport(pos, arg1)
end
---@param teleType integer
---@param bitval integer
---@param setval integer?
---@return nil
function CBaseEntity:addTeleport(teleType, bitval, setval)
end
2025-01-27 04:35:00 -05:00
---@param pos table
---@param mode integer
---@return nil
function CBaseEntity:positionSpecial(pos, mode)
end
---@nodiscard
---@param type integer
---@param abysseaRegionObj integer?
---@return integer
function CBaseEntity:getTeleport(type, abysseaRegionObj)
end
---@nodiscard
---@param type integer
---@return table
function CBaseEntity:getTeleportTable(type)
end
---@nodiscard
---@param tType integer
---@param bit integer
---@param arg2 integer?
---@return boolean
function CBaseEntity:hasTeleport(tType, bit, arg2)
end
---@param type integer
---@param teleportObj table|boolean
---@return nil
function CBaseEntity:setTeleportMenu(type, teleportObj)
end
---@nodiscard
---@param type integer
---@return table
function CBaseEntity:getTeleportMenu(type)
end
---@return nil
function CBaseEntity:setHomePoint()
end
2026-05-10 03:39:37 -06:00
---@param voucherId integer
---@return nil
function CBaseEntity:learnMazeVoucher(voucherId)
end
---@nodiscard
---@param voucherId integer
---@return boolean
function CBaseEntity:hasMazeVoucher(voucherId)
end
---@param runeId integer
---@return nil
function CBaseEntity:learnMazeRune(runeId)
end
---@nodiscard
---@param runeId integer
---@return boolean
function CBaseEntity:hasMazeRune(runeId)
end
---@param charName string
---@return nil
function CBaseEntity:resetPlayer(charName)
end
---@param targetID integer
---@param option boolean?
---@return nil
function CBaseEntity:gotoEntity(targetID, option)
end
---@param playerName string
---@return boolean
function CBaseEntity:gotoPlayer(playerName)
end
---@param playerName string
---@return boolean
function CBaseEntity:bringPlayer(playerName)
end
---@nodiscard
---@param slot integer
---@return integer
function CBaseEntity:getEquipID(slot)
end
---@nodiscard
---@param slot integer
---@return CItem?
function CBaseEntity:getEquippedItem(slot)
end
---@nodiscard
---@param equipmentID integer
---@return boolean
function CBaseEntity:hasEquipped(equipmentID)
end
---@nodiscard
---@param itemID integer
---@param location integer?
---@return boolean
function CBaseEntity:hasItem(itemID, location)
end
---@nodiscard
---@param itemID integer
---@return integer
function CBaseEntity:getItemCount(itemID)
end
-- TODO: This one is going to be really messy, might be better to create multiple definitions
-- for readability.
---@return CItem?
function CBaseEntity:addItem(...)
end
---@param itemID integer
---@param quantity integer
---@param containerID integer?
---@return boolean
function CBaseEntity:delItem(itemID, quantity, containerID)
end
2025-03-07 02:00:46 -07:00
---@param itemId integer
---@param quantity integer
---@param containerId integer
---@param slotId integer
---@return boolean
function CBaseEntity:delItemAt(itemId, quantity, containerId, slotId)
end
---@param containerID integer?
---@return boolean
function CBaseEntity:delContainerItems(containerID)
end
---@param itemID integer
---@return boolean
function CBaseEntity:addUsedItem(itemID)
end
---@param itemID integer
---@param arg1 integer?
---@return boolean
function CBaseEntity:addTempItem(itemID, arg1)
end
---@nodiscard
---@param itemID integer
---@return integer
function CBaseEntity:getWornUses(itemID)
end
---@nodiscard
---@param itemID integer
---@return integer
function CBaseEntity:incrementItemWear(itemID)
end
---@nodiscard
---@param itemID integer
---@param location integer?
---@return CItem?
function CBaseEntity:findItem(itemID, location)
end
2025-03-07 02:00:46 -07:00
---@nodiscard
---@param itemID integer
---@param location integer?
---@return table
function CBaseEntity:findItems(itemID, location)
end
2025-08-16 23:43:40 -06:00
---@nodiscard
---@param location integer?
---@return CItem[]
function CBaseEntity:getItems(location)
end
---@param size integer
---@param arg1 integer?
---@return nil
function CBaseEntity:createShop(size, arg1)
end
---@class ShopItemRequirements
---@field job xi.job? Required job; paired with `level`.
---@field level integer? Required job level. Only used with `job`.
---@field guild xi.skill? Required guild/craft skill; paired with `rank`.
---@field rank xi.craftRank? Required guild rank. Only used with `guild`.
---@param itemID integer
---@param rawPrice number
---@param requirements ShopItemRequirements?
---@return nil
function CBaseEntity:addShopItem(itemID, rawPrice, requirements)
end
---@nodiscard
---@param guildID integer
---@return table
function CBaseEntity:getCurrentGPItem(guildID)
end
---@param lsname string
---@return boolean
function CBaseEntity:breakLinkshell(lsname)
end
---@param lsname string
---@param equip boolean
---@return boolean
function CBaseEntity:addLinkpearl(lsname, equip)
end
2026-05-11 01:06:13 -06:00
---@class LinkshellConciergeSlot
---@field groupId integer
---@field groupKey integer
---@field color integer
---@field flag integer
---@field name string
---@field lang integer
---@field membersGoal integer
---@field activeTier integer
---@field characteristics integer
---@class LinkshellConciergeView
---@field yourSlot integer?
---@field postedDays integer?
---@field slots table<integer, LinkshellConciergeSlot>?
---@param data LinkshellConciergeView
---@return nil
function CBaseEntity:sendLinkshellConcierge(data)
end
---@nodiscard
---@param locationID integer
---@return integer
function CBaseEntity:getContainerSize(locationID)
end
---@param locationID integer
---@param newSize integer
---@return nil
function CBaseEntity:changeContainerSize(locationID, newSize)
end
---@nodiscard
---@param locID integer?
---@return integer
function CBaseEntity:getFreeSlotsCount(locID)
end
---@return nil
function CBaseEntity:confirmTrade()
end
---@return nil
function CBaseEntity:tradeComplete()
end
---@return CTradeContainer?
function CBaseEntity:getTrade()
end
---@nodiscard
---@param itemID integer
---@param chkLevel boolean?
---@return boolean
function CBaseEntity:canEquipItem(itemID, chkLevel)
end
---@param itemID integer
---@param container integer?
2025-08-16 23:43:40 -06:00
---@param slot integer?
---@return nil
2025-08-16 23:43:40 -06:00
function CBaseEntity:equipItem(itemID, container, slot)
end
---@param itemID integer
---@return nil
function CBaseEntity:unequipItem(itemID)
end
---@param equipBlock integer
---@return nil
function CBaseEntity:setEquipBlock(equipBlock)
end
---@param slot integer
---@return nil
function CBaseEntity:lockEquipSlot(slot)
end
---@param slot integer
---@return nil
function CBaseEntity:unlockEquipSlot(slot)
end
---@nodiscard
---@param slot integer
---@return boolean
function CBaseEntity:hasSlotEquipped(slot)
end
---@nodiscard
---@return integer
function CBaseEntity:getShieldSize()
end
---@nodiscard
---@return integer
function CBaseEntity:getShieldDefense()
end
---@param setId integer
---@param modId integer
---@param modValue integer
---@return nil
function CBaseEntity:addGearSetMod(setId, modId, modValue)
end
---@return nil
function CBaseEntity:clearGearSetMods()
end
---@nodiscard
---@param container integer
---@param slotID integer
---@param equipID integer
---@return CItem?
function CBaseEntity:getStorageItem(container, slotID, equipID)
end
---@nodiscard
---@param slipId integer
---@param extraTable table
---@param storableItemIdsTable table
---@return integer
function CBaseEntity:storeWithPorterMoogle(slipId, extraTable, storableItemIdsTable)
end
---@nodiscard
---@param slipId integer
---@return table
function CBaseEntity:getRetrievableItemsForSlip(slipId)
end
---@param slipId integer
---@param itemId integer
---@param extraId integer
---@param extraData integer
---@return nil
function CBaseEntity:retrieveItemFromSlip(slipId, itemId, extraId, extraData)
end
---@nodiscard
---@return integer
function CBaseEntity:getRace()
end
2025-06-06 02:40:48 -06:00
---@nodiscard
---@return integer
function CBaseEntity:getFace()
end
---@nodiscard
---@return integer
function CBaseEntity:getGender()
end
2025-06-06 02:40:48 -06:00
---@nodiscard
---@return integer
function CBaseEntity:getSize()
end
---@nodiscard
---@param newRace integer
---@param newFace integer
---@param newSize integer
---@return boolean
function CBaseEntity:raceChange(newRace, newFace, newSize)
end
---@nodiscard
---@return string
function CBaseEntity:getName()
end
---@nodiscard
---@return string
function CBaseEntity:getPacketName()
end
---@param newName string
---@param arg2 boolean?
---@return nil
function CBaseEntity:renameEntity(newName, arg2)
end
---@param isHidden boolean
---@return nil
function CBaseEntity:hideName(isHidden)
end
---@nodiscard
---@return integer
function CBaseEntity:getModelId()
end
---@param modelId integer
---@param slotObj integer?
---@return nil
function CBaseEntity:setModelId(modelId, slotObj)
end
2025-06-06 02:40:48 -06:00
---@param look table
---@return nil
function CBaseEntity:setLook(look)
end
---@nodiscard
---@return table
function CBaseEntity:getEquipmentModelIds()
end
---@nodiscard
---@return integer
function CBaseEntity:getCostume()
end
---@param costume integer
---@return nil
function CBaseEntity:setCostume(costume)
end
---@nodiscard
---@return integer
function CBaseEntity:getCostume2()
end
---@param costume integer
---@return nil
function CBaseEntity:setCostume2(costume)
end
---@nodiscard
---@return integer
function CBaseEntity:getAnimation()
end
---@param animation integer
---@return nil
function CBaseEntity:setAnimation(animation)
end
---@nodiscard
---@return integer
function CBaseEntity:getAnimationSub()
end
---@param animationsub integer
---@param sendUpdate boolean?
---@return nil
function CBaseEntity:setAnimationSub(animationsub, sendUpdate)
end
---@param spawnAnimation integer
---@return nil
function CBaseEntity:setSpawnAnimation(spawnAnimation)
end
---@nodiscard
---@return boolean
function CBaseEntity:getCallForHelpFlag()
end
---@param cfh boolean
---@return nil
function CBaseEntity:setCallForHelpFlag(cfh)
end
---@nodiscard
---@return boolean
function CBaseEntity:getCallForHelpBlocked()
end
---@param blocked boolean
---@return nil
function CBaseEntity:setCallForHelpBlocked(blocked)
end
---@nodiscard
---@return integer
function CBaseEntity:getNation()
end
---@param nation integer
---@return nil
function CBaseEntity:setNation(nation)
end
---@nodiscard
---@return integer
function CBaseEntity:getAllegiance()
end
---@param allegiance integer
---@return nil
function CBaseEntity:setAllegiance(allegiance)
end
---@nodiscard
---@return integer
function CBaseEntity:getCampaignAllegiance()
end
---@param allegiance integer
---@return nil
function CBaseEntity:setCampaignAllegiance(allegiance)
end
---@nodiscard
---@return boolean
function CBaseEntity:isSeekingParty()
end
---@nodiscard
---@return boolean
function CBaseEntity:getNewPlayer()
end
---@param newplayer boolean
---@return nil
function CBaseEntity:setNewPlayer(newplayer)
end
---@nodiscard
---@return boolean
function CBaseEntity:getMentor()
end
---@param mentor boolean
---@return nil
function CBaseEntity:setMentor(mentor)
end
---@nodiscard
---@return integer
function CBaseEntity:getGMLevel()
end
---@param level integer
---@return nil
function CBaseEntity:setGMLevel(level)
end
---@param level integer
---@return nil
function CBaseEntity:setVisibleGMLevel(level)
end
---@nodiscard
---@return integer
function CBaseEntity:getVisibleGMLevel()
end
---@nodiscard
---@return boolean
function CBaseEntity:getGMHidden()
end
---@param isHidden boolean
---@return nil
function CBaseEntity:setGMHidden(isHidden)
end
---@nodiscard
---@return boolean
function CBaseEntity:getWallhack()
end
---@param enable boolean
---@return nil
function CBaseEntity:setWallhack(enable)
end
2025-10-07 11:18:03 +02:00
---@param isFrozen boolean
---@return nil
function CBaseEntity:setFreezeFlag(isFrozen)
end
---@nodiscard
---@return boolean
function CBaseEntity:isJailed()
end
---@return nil
function CBaseEntity:jail()
end
---@nodiscard
---@param misc integer
---@return boolean
function CBaseEntity:canUseMisc(misc)
end
---@nodiscard
---@return integer
function CBaseEntity:getSpeed()
end
---@nodiscard
---@return integer
function CBaseEntity:getBaseSpeed()
end
---@param speedVal integer
---@return nil
function CBaseEntity:setBaseSpeed(speedVal)
end
---@param speedVal integer
---@return nil
function CBaseEntity:setAnimationSpeed(speedVal)
end
---@nodiscard
---@param shouldUpdate boolean?
---@return integer
function CBaseEntity:getPlaytime(shouldUpdate)
end
---@nodiscard
---@return integer
function CBaseEntity:getTimeCreated()
end
---@nodiscard
---@return integer
function CBaseEntity:getMainJob()
end
---@nodiscard
---@return integer
function CBaseEntity:getSubJob()
end
---@param newJob integer
---@return nil
function CBaseEntity:changeJob(newJob)
end
---@param subJob integer
---@return nil
function CBaseEntity:changesJob(subJob)
end
---@param JobID integer
---@return nil
function CBaseEntity:unlockJob(JobID)
end
---@nodiscard
---@param job integer
---@return boolean
function CBaseEntity:hasJob(job)
end
---@nodiscard
---@return integer
function CBaseEntity:getMainLvl()
end
---@nodiscard
---@return integer
function CBaseEntity:getSubLvl()
end
---@nodiscard
---@param JobID integer
---@return integer
function CBaseEntity:getJobLevel(JobID)
end
---@param level integer
---@return nil
function CBaseEntity:setLevel(level)
end
---@param slevel integer
---@return nil
function CBaseEntity:setsLevel(slevel)
end
---@nodiscard
---@return integer
function CBaseEntity:getLevelCap()
end
---@param cap integer
---@return nil
function CBaseEntity:setLevelCap(cap)
end
---@param level integer?
---@return integer
function CBaseEntity:levelRestriction(level)
end
---@param jobID integer
---@param level integer
---@return nil
function CBaseEntity:addWyvernJobTraits(jobID, level)
end
---@nodiscard
---@return table
function CBaseEntity:getMonstrosityData()
end
---@param table table
---@return nil
function CBaseEntity:setMonstrosityData(table)
end
---@nodiscard
---@return boolean
function CBaseEntity:getBelligerencyFlag()
end
---@param flag boolean
---@return nil
function CBaseEntity:setBelligerencyFlag(flag)
end
---@nodiscard
---@return integer
function CBaseEntity:getMonstrositySize()
end
---@param x number
---@param y number
---@param z number
---@param rot integer
---@param zoneId integer
---@param mjob integer
---@param sjob integer
---@return nil
function CBaseEntity:setMonstrosityEntryData(x, y, z, rot, zoneId, mjob, sjob)
end
---@nodiscard
---@return integer
function CBaseEntity:getTitle()
end
---@nodiscard
---@param titleID integer
---@return boolean
function CBaseEntity:hasTitle(titleID)
end
---@param titleID integer
---@return nil
function CBaseEntity:addTitle(titleID)
end
---@param titleID integer
---@return nil
function CBaseEntity:setTitle(titleID)
end
---@param titleID integer
---@return nil
function CBaseEntity:delTitle(titleID)
end
---@nodiscard
---@param areaObj table|integer
---@return integer
function CBaseEntity:getFame(areaObj)
end
---@param areaObj table|integer
---@param fame integer
---@return nil
function CBaseEntity:addFame(areaObj, fame)
end
---@param areaObj table|integer
---@param fame integer
---@return nil
function CBaseEntity:setFame(areaObj, fame)
end
---@nodiscard
---@param areaObj table|integer
---@return integer
function CBaseEntity:getFameLevel(areaObj)
end
---@nodiscard
---@param nation integer
---@return integer
function CBaseEntity:getRank(nation)
end
---@param rank integer
---@return nil
function CBaseEntity:setRank(rank)
end
---@nodiscard
---@return integer
function CBaseEntity:getRankPoints()
end
---@param rankPoints integer
---@return nil
function CBaseEntity:addRankPoints(rankPoints)
end
---@param rankPoints integer
---@return nil
function CBaseEntity:setRankPoints(rankPoints)
end
---@param questLogID integer
---@param questID integer
---@return nil
function CBaseEntity:addQuest(questLogID, questID)
end
---@param questLogID integer
---@param questID integer
---@return nil
function CBaseEntity:delCurrentQuest(questLogID, questID)
end
---@param questLogID integer
---@param questID integer
---@return nil
function CBaseEntity:delQuest(questLogID, questID)
end
---@nodiscard
---@param questLogID integer
---@param questID integer
---@return xi.questStatus
function CBaseEntity:getQuestStatus(questLogID, questID)
end
---@nodiscard
---@param questLogID integer
---@param questID integer
---@return boolean
function CBaseEntity:hasCompletedQuest(questLogID, questID)
end
---@param questLogID integer
---@param questID integer
---@return nil
function CBaseEntity:completeQuest(questLogID, questID)
end
---@param missionLogID integer
---@param missionID integer
---@return nil
function CBaseEntity:addMission(missionLogID, missionID)
end
---@param missionLogID integer
---@param missionID integer
---@return nil
function CBaseEntity:delMission(missionLogID, missionID)
end
---@nodiscard
---@param missionLogObj integer|table
---@return integer
function CBaseEntity:getCurrentMission(missionLogObj)
end
---@nodiscard
---@param missionLogID integer
---@param missionID integer
---@return boolean
function CBaseEntity:hasCompletedMission(missionLogID, missionID)
end
---@param missionLogID integer
---@param missionID integer
---@return nil
function CBaseEntity:completeMission(missionLogID, missionID)
end
---@param missionLogID integer
---@param arg2Obj integer
---@param arg3Obj integer?
---@return nil
function CBaseEntity:setMissionStatus(missionLogID, arg2Obj, arg3Obj)
end
---@nodiscard
---@param missionLogID integer
---@param missionStatusPosObj integer?
---@return integer
function CBaseEntity:getMissionStatus(missionLogID, missionStatusPosObj)
end
---@param missionLogID integer
---@param completed boolean
---@return nil
function CBaseEntity:sendPartialMissionLog(missionLogID, completed)
end
---@param recordID integer
---@param arg1 boolean?
---@param arg2 boolean?
---@return nil
function CBaseEntity:setEminenceCompleted(recordID, arg1, arg2)
end
---@nodiscard
---@param recordID integer
---@return boolean
function CBaseEntity:getEminenceCompleted(recordID)
end
---@nodiscard
---@return integer
function CBaseEntity:getNumEminenceCompleted()
end
---@param recordID integer
---@param progress integer
---@param arg2 integer?
---@return nil
function CBaseEntity:setEminenceProgress(recordID, progress, arg2)
end
---@nodiscard
---@param recordID integer
---@return integer?
function CBaseEntity:getEminenceProgress(recordID)
end
---@nodiscard
---@param recordID integer
---@return boolean
function CBaseEntity:hasEminenceRecord(recordID)
end
---@param eventNum integer
---@param reqTable table?
---@return nil
function CBaseEntity:triggerRoeEvent(eventNum, reqTable)
end
---@param leaderID integer
---@return nil
function CBaseEntity:setUnityLeader(leaderID)
end
---@nodiscard
---@return integer
function CBaseEntity:getUnityLeader()
end
---@nodiscard
---@param unityObj integer?
---@return integer?
function CBaseEntity:getUnityRank(unityObj)
end
---@nodiscard
---@return table
function CBaseEntity:getClaimedDeedMask()
end
---@return nil
function CBaseEntity:toggleReceivedDeedRewards()
end
---@param deedBitNum integer
---@return nil
function CBaseEntity:setClaimedDeed(deedBitNum)
end
---@return nil
function CBaseEntity:resetClaimedDeeds()
end
---@param uniqueEventId integer
---@return nil
function CBaseEntity:setUniqueEvent(uniqueEventId)
end
---@param uniqueEventId integer
---@return nil
function CBaseEntity:delUniqueEvent(uniqueEventId)
end
---@nodiscard
---@param uniqueEventId integer
---@return boolean
function CBaseEntity:hasCompletedUniqueEvent(uniqueEventId)
end
---@param missionID integer
---@return nil
function CBaseEntity:addAssault(missionID)
end
---@param missionID integer
---@return nil
function CBaseEntity:delAssault(missionID)
end
---@nodiscard
---@return integer
function CBaseEntity:getCurrentAssault()
end
---@nodiscard
---@param missionID integer
---@return boolean
function CBaseEntity:hasCompletedAssault(missionID)
end
---@param missionID integer
---@return nil
function CBaseEntity:completeAssault(missionID)
end
---@param keyItemID xi.keyItem
---@return nil
function CBaseEntity:addKeyItem(keyItemID)
end
---@nodiscard
---@param keyItemID xi.keyItem
---@return boolean
function CBaseEntity:hasKeyItem(keyItemID)
end
---@param keyItemID integer
---@return nil
function CBaseEntity:delKeyItem(keyItemID)
end
---@nodiscard
---@param keyItemID xi.keyItem
---@return boolean
function CBaseEntity:seenKeyItem(keyItemID)
end
---@param keyItemID xi.keyItem
---@return nil
function CBaseEntity:unseenKeyItem(keyItemID)
end
---@param exp integer
---@return nil
function CBaseEntity:addExp(exp)
end
---@param capacity integer
---@return nil
function CBaseEntity:addCapacityPoints(capacity)
end
---@param exp integer
---@return nil
function CBaseEntity:delExp(exp)
end
---@nodiscard
---@param merit integer
---@return integer
function CBaseEntity:getMerit(merit)
end
---@nodiscard
---@return integer
function CBaseEntity:getMeritCount()
end
---@param numPoints integer
---@return nil
function CBaseEntity:setMerits(numPoints)
end
---@nodiscard
---@return integer
function CBaseEntity:getSpentJobPoints()
end
---@nodiscard
---@param jpType integer
---@return integer
function CBaseEntity:getJobPointLevel(jpType)
end
Add in Functionality to Job Points for NPC Oboro add in ability to add, delete, get job points based on specified job. ------------------------------------------------------------------ -------------- Get player Job points to exchange ----------------- ------------------------------------------------------------------ local jpTurnedIn = 10000 - player:getCharVar('[Oboro]JPTurnedIn') local jpTradeIn = bit.band(bit.rshift(option, 16), 0xFFFF) local jpJob = bit.band(bit.rshift(option, 32), 0xFFFF) - 299 local jobPointTotals ={} for job = 1, 22 do table.insert(jobPointTotals, player:getJobPoints(job)) end local totalPoints = 0 if totalPoints == 0 then for _, points in pairs(jobPointTotals) do totalPoints = totalPoints + points end end if option == 101 then player:updateEvent(2,jpTurnedIn,700,29,0,0,0,0) end if option == 110 then player:updateEvent(jobPointTotals[15],jobPointTotals[16],jobPointTotals[17],jobPointTotals[18],jobPointTotals[19],jobPointTotals[20],jobPointTotals[21],jobPointTotals[21]) end if option == 111 then player:updateEvent(jobPointTotals[7],jobPointTotals[8],jobPointTotals[9],jobPointTotals[10],jobPointTotals[11],jobPointTotals[12],jobPointTotals[13],jobPointTotals[14]) end if option == 112 then player:updateEvent(jobPointTotals[1],jobPointTotals[2],jobPointTotals[3],jobPointTotals[4],jobPointTotals[5],jobPointTotals[6],0,0) end ----------Exchange Job Points--------- if jpTradeIn + jpTurnedIn > 10000 then jpTradeIn = 10000 - jpTurnedIn else if jpTradeIn > 1 and jpTradeIn <= 500 then -- usedJPs, type of weapon, remaing , remaining points between jobs player:updateEvent(jpTradeIn,2,jpTurnedIn - jpTradeIn,totalPoints,0,0,0,0) player:setCharVar('[Oboro]JPTurnedIn', player:getCharVar('[Oboro]JPTurnedIn') + jpTradeIn) player:delJobPoints(jpJob, player:getJobPoints(jpJob) - jpTradeIn) end end
2025-01-12 14:32:01 -07:00
---@param jobID integer
---@param amount integer
---@return nil
function CBaseEntity:addJobPoints(jobID, amount)
end
---@param jobID integer
---@param amount integer
---@return nil
function CBaseEntity:delJobPoints(jobID, amount)
end
---@param jobID integer
---@return integer
function CBaseEntity:getJobPoints(jobID)
end
---@param amount integer
---@return nil
function CBaseEntity:setJobPoints(amount)
end
---@param amount integer
---@return nil
function CBaseEntity:setCapacityPoints(amount)
end
---@return nil
function CBaseEntity:masterJob()
end
---@nodiscard
---@return integer
function CBaseEntity:getGil()
end
---@param gil integer
---@return nil
function CBaseEntity:addGil(gil)
end
---@param amount integer
---@return nil
function CBaseEntity:setGil(amount)
end
---@param gil integer
---@return nil
function CBaseEntity:delGil(gil)
end
---@nodiscard
---@param currencyType string
---@return integer
function CBaseEntity:getCurrency(currencyType)
end
---@param currencyType string
---@param amount integer
---@param maxObj integer?
---@return nil
function CBaseEntity:addCurrency(currencyType, amount, maxObj)
end
---@param currencyType string
---@param amount integer
---@return nil
function CBaseEntity:setCurrency(currencyType, amount)
end
---@param currencyType string
---@param amount integer
function CBaseEntity:delCurrency(currencyType, amount)
end
---@nodiscard
---@return integer
function CBaseEntity:getCP()
end
---@param cp integer
---@return nil
function CBaseEntity:addCP(cp)
end
---@param cp integer
---@return nil
function CBaseEntity:delCP(cp)
end
---@nodiscard
---@param sealType integer
---@return integer
function CBaseEntity:getSeals(sealType)
end
---@param points integer
---@param sealType integer
---@return nil
function CBaseEntity:addSeals(points, sealType)
end
---@param points integer
---@param sealType integer
---@return nil
function CBaseEntity:delSeals(points, sealType)
end
---@nodiscard
---@param region integer
---@return integer
function CBaseEntity:getAssaultPoint(region)
end
---@param region integer
---@param points integer
---@return nil
function CBaseEntity:addAssaultPoint(region, points)
end
---@param region integer
---@param points integer
---@return nil
function CBaseEntity:delAssaultPoint(region, points)
end
---@nodiscard
---@param guildID integer
---@param slotID integer
---@return table
function CBaseEntity:addGuildPoints(guildID, slotID)
end
---@nodiscard
---@return integer
function CBaseEntity:getHP()
end
---@nodiscard
---@return integer
function CBaseEntity:getHPP()
end
---@nodiscard
---@return integer
function CBaseEntity:getMaxHP()
end
---@nodiscard
---@return integer
function CBaseEntity:getBaseHP()
end
---@param hpAdd integer
---@return integer
function CBaseEntity:addHP(hpAdd)
end
---@param hpAdd integer
---@return integer
function CBaseEntity:addHPLeaveSleeping(hpAdd)
end
---@param value integer
---@return nil
function CBaseEntity:setHP(value)
end
2024-08-28 11:58:34 -07:00
---@param value integer
---@return nil
function CBaseEntity:setMaxHP(value)
end
---@param restoreAmt integer
---@return integer
function CBaseEntity:restoreHP(restoreAmt)
end
---@param delAmt integer
---@return nil
function CBaseEntity:delHP(delAmt)
end
---@param damage integer
---@param attacker CBaseEntity?
---@param atkType integer?
---@param dmgType integer?
---@param flags table?
---@return nil
function CBaseEntity:takeDamage(damage, attacker, atkType, dmgType, flags)
end
---@param value boolean
---@return nil
function CBaseEntity:hideHP(value)
end
---@nodiscard
---@return integer
function CBaseEntity:getDeathType()
end
---@param value integer
---@return nil
function CBaseEntity:setDeathType(value)
end
---@nodiscard
---@return integer
function CBaseEntity:getMP()
end
---@nodiscard
---@return integer
function CBaseEntity:getMPP()
end
---@nodiscard
---@return integer
function CBaseEntity:getMaxMP()
end
---@nodiscard
---@return integer
function CBaseEntity:getBaseMP()
end
---@param amount integer
---@return integer
function CBaseEntity:addMP(amount)
end
---@param value integer
---@return nil
function CBaseEntity:setMP(value)
end
2025-01-08 21:24:20 -07:00
---@param value integer
---@return nil
function CBaseEntity:setMaxMP(value)
end
---@param amount integer
---@return integer
function CBaseEntity:restoreMP(amount)
end
---@param amount integer
---@return integer
function CBaseEntity:delMP(amount)
end
---@nodiscard
---@return number
function CBaseEntity:getTP()
end
---@param amount integer
---@return nil
function CBaseEntity:addTP(amount)
end
---@param value integer
---@return nil
function CBaseEntity:setTP(value)
end
---@param amount integer
---@return integer
function CBaseEntity:delTP(amount)
end
---@return nil
function CBaseEntity:updateHealth()
end
---@nodiscard
---@return integer
function CBaseEntity:getAverageItemLevel()
end
---@param skill integer
---@return nil
function CBaseEntity:capSkill(skill)
end
---@return nil
function CBaseEntity:capAllSkills()
end
---@nodiscard
---@param skillId integer
---@return integer
function CBaseEntity:getSkillLevel(skillId)
end
---@param SkillID integer
---@param SkillAmount integer
---@return nil
function CBaseEntity:setSkillLevel(SkillID, SkillAmount)
end
---@nodiscard
---@param level integer
---@param jobId integer
---@param skillId integer
---@return integer
function CBaseEntity:getMaxSkillLevel(level, jobId, skillId)
end
---@nodiscard
---@param rankID integer
---@return integer
function CBaseEntity:getSkillRank(rankID)
end
---@param skillID integer
---@param newrank integer
---@return nil
function CBaseEntity:setSkillRank(skillID, newrank)
end
---@nodiscard
---@param skillID integer
---@return integer
function CBaseEntity:getCharSkillLevel(skillID)
end
---@param wsUnlockId integer
---@return nil
function CBaseEntity:addLearnedWeaponskill(wsUnlockId)
end
---@nodiscard
---@param wsUnlockId integer
---@return boolean
function CBaseEntity:hasLearnedWeaponskill(wsUnlockId)
end
---@param wsUnlockId integer
---@return nil
function CBaseEntity:delLearnedWeaponskill(wsUnlockId)
end
---@param skill integer
---@param level integer
---@param forceSkillUpObj boolean?
---@param useSubSkillObj boolean?
---@return nil
function CBaseEntity:trySkillUp(skill, level, forceSkillUpObj, useSubSkillObj)
end
---@nodiscard
---@param slotID integer
---@param points integer
---@return boolean
function CBaseEntity:addWeaponSkillPoints(slotID, points)
end
---@param abilityID integer
---@return nil
function CBaseEntity:addLearnedAbility(abilityID)
end
---@nodiscard
---@param abilityID integer
---@return boolean
function CBaseEntity:hasLearnedAbility(abilityID)
end
---@nodiscard
---@param abilityID integer
---@return integer
function CBaseEntity:canLearnAbility(abilityID)
end
---@param abilityID integer
---@return nil
function CBaseEntity:delLearnedAbility(abilityID)
end
---@param spellID integer
2025-10-17 08:56:00 -05:00
---@param arg0 table?
---@return nil
2025-10-17 08:56:00 -05:00
function CBaseEntity:addSpell(spellID, arg0)
end
---@nodiscard
---@param spellID integer
---@return boolean
function CBaseEntity:hasSpell(spellID)
end
---@nodiscard
---@param spellID integer
---@return integer
function CBaseEntity:canLearnSpell(spellID)
end
---@param spellID integer
2025-10-17 08:56:00 -05:00
---@param arg0 table?
---@return nil
2025-10-17 08:56:00 -05:00
function CBaseEntity:delSpell(spellID, arg0)
end
---@return nil
function CBaseEntity:recalculateSkillsTable()
end
---@return nil
function CBaseEntity:recalculateAbilitiesTable()
end
---@nodiscard
---@param PLuaEntityTarget CBaseEntity
---@param aoeType integer?
---@param radiusOrigin integer?
---@param distance number?
---@param findFlags integer?
---@param validTargets integer?
---@return table
function CBaseEntity:getEntitiesInRange(PLuaEntityTarget, aoeType, radiusOrigin, distance, findFlags, validTargets)
end
---@nodiscard
---@return table
function CBaseEntity:getParty()
end
---@nodiscard
---@return table
function CBaseEntity:getPartyWithTrusts()
end
---@nodiscard
---@param arg0 integer?
---@return integer
function CBaseEntity:getPartySize(arg0)
end
---@nodiscard
---@param job integer
---@return boolean
function CBaseEntity:hasPartyJob(job)
end
---@nodiscard
---@param member integer
---@param allianceparty integer
---@return CBaseEntity?
function CBaseEntity:getPartyMember(member, allianceparty)
end
---@nodiscard
---@return CBaseEntity?
function CBaseEntity:getPartyLeader()
end
---@nodiscard
---@return integer
function CBaseEntity:getLeaderID()
end
---@nodiscard
---@return integer
function CBaseEntity:getPartyLastMemberJoinedTime()
end
---@param range number
---@param luaFunction function
---@return nil
function CBaseEntity:forMembersInRange(range, luaFunction)
end
-- NOTE: This function is currently unused, and defaults to 0-values for the parameters on init.
-- Requiring all parameters at this time, and may need to be changed moving forward.
---@param statusId integer
---@param icon integer
---@param power integer
---@param tick integer
---@param duration integer
---@param subid integer
---@param subPower integer
---@param tier integer
---@param flags integer
---@return nil
function CBaseEntity:addPartyEffect(statusId, icon, power, tick, duration, subid, subPower, tier, flags)
end
---@nodiscard
---@param effectid integer
---@return boolean
function CBaseEntity:hasPartyEffect(effectid)
end
---@param effectid integer
---@return nil
function CBaseEntity:removePartyEffect(effectid)
end
---@nodiscard
---@return table
function CBaseEntity:getAlliance()
end
---@nodiscard
---@return integer
function CBaseEntity:getAllianceSize()
end
---@return nil
function CBaseEntity:reloadParty()
end
---@return nil
function CBaseEntity:disableLevelSync()
end
---@nodiscard
---@return integer
function CBaseEntity:checkSoloPartyAlliance()
end
---@nodiscard
---@param PLuaBaseEntity CBaseEntity
---@param minRange number?
---@return boolean
function CBaseEntity:checkKillCredit(PLuaBaseEntity, minRange)
end
---@nodiscard
---@param PLuaBaseEntity CBaseEntity
---@return integer
function CBaseEntity:checkDifficulty(PLuaBaseEntity)
end
---@nodiscard
---@return CInstance?
function CBaseEntity:getInstance()
end
---@param PLuaInstance CInstance
---@return nil
function CBaseEntity:setInstance(PLuaInstance)
end
---@param instanceID integer
---@return nil
function CBaseEntity:createInstance(instanceID)
end
---@param PLuaBaseEntity CBaseEntity
---@param response integer
---@return nil
function CBaseEntity:instanceEntry(PLuaBaseEntity, response)
end
---@deprecated
function CBaseEntity:isInAssault()
end
---@nodiscard
---@return integer
function CBaseEntity:getConfrontationEffect()
end
---@param targetID integer
---@return integer
function CBaseEntity:copyConfrontationEffect(targetID)
end
---@nodiscard
---@return CBattlefield?
function CBaseEntity:getBattlefield()
end
---@nodiscard
---@return integer
function CBaseEntity:getBattlefieldID()
end
---@param arg0 integer?
---@param arg1 integer?
---@param arg2 integer?
---@param arg3 table?
---@return integer
function CBaseEntity:registerBattlefield(arg0, arg1, arg2, arg3)
end
---@nodiscard
---@param battlefieldID integer
---@return boolean
function CBaseEntity:battlefieldAtCapacity(battlefieldID)
end
---@param area integer?
---@return boolean
function CBaseEntity:enterBattlefield(area)
end
---@param leavecode integer
---@return boolean
function CBaseEntity:leaveBattlefield(leavecode)
end
---@nodiscard
---@return boolean
function CBaseEntity:isInDynamis()
end
---@param entered boolean
---@return nil
function CBaseEntity:setEnteredBattlefield(entered)
end
---@nodiscard
---@return boolean
function CBaseEntity:hasEnteredBattlefield()
end
---@nodiscard
---@return boolean
function CBaseEntity:isAlive()
end
---@nodiscard
---@return boolean
function CBaseEntity:isDead()
end
---@nodiscard
---@return boolean
function CBaseEntity:hasRaiseTractorMenu()
end
---@param raiseLevel integer
---@return nil
function CBaseEntity:sendRaise(raiseLevel)
end
---@param raiseLevel integer
---@return nil
function CBaseEntity:sendReraise(raiseLevel)
end
---@param xPos number
---@param yPos number
---@param zPos number
---@param rotation integer
---@return nil
function CBaseEntity:sendTractor(xPos, yPos, zPos, rotation)
end
---@return nil
function CBaseEntity:allowSendRaisePrompt()
end
---@param secondsObj integer?
function CBaseEntity:countdown(secondsObj)
end
---@param obj table
---@return nil
function CBaseEntity:objectiveUtility(obj)
end
---@param obj integer[]?
---@return nil
function CBaseEntity:enableEntities(obj)
end
---@param PTarget CBaseEntity
---@param animId integer
---@param mode integer
---@return nil
function CBaseEntity:independentAnimation(PTarget, animId, mode)
end
---@param requestedTarget integer
---@return nil
function CBaseEntity:engage(requestedTarget)
end
---@nodiscard
---@return boolean
function CBaseEntity:isEngaged()
end
---@return nil
function CBaseEntity:disengage()
end
---@param ms integer
---@param func function
---@return nil
function CBaseEntity:timer(ms, func)
end
---@param ms integer
---@param func function
---@return nil
function CBaseEntity:queue(ms, func)
end
---@param recastCont integer
---@param recastID integer
---@param duration integer
---@return nil
function CBaseEntity:addRecast(recastCont, recastID, duration)
end
---@nodiscard
---@param rType integer
---@param recastID integer
---@param arg2 integer?
---@return boolean
function CBaseEntity:hasRecast(rType, recastID, arg2)
end
---@param rType integer
---@param recastID integer
---@return nil
function CBaseEntity:resetRecast(rType, recastID)
end
---@return nil
function CBaseEntity:resetRecasts()
end
---@param eventName string
---@param identifier string
---@param func function
---@return nil
function CBaseEntity:addListener(eventName, identifier, func)
end
---@param identifier string
---@return nil
function CBaseEntity:removeListener(identifier)
end
---@param eventName string
---@param ... any
---@return nil
function CBaseEntity:triggerListener(eventName, ...)
end
---@param eventName string
---@return boolean
function CBaseEntity:hasListener(eventName)
end
---@nodiscard
---@param targetID integer
---@return CBaseEntity?
function CBaseEntity:getEntity(targetID)
end
---@nodiscard
---@return boolean
function CBaseEntity:canChangeState()
end
---@return nil
function CBaseEntity:wakeUp()
end
---@param battleID integer
---@return nil
function CBaseEntity:setBattleID(battleID)
end
---@nodiscard
---@return integer
function CBaseEntity:getBattleID()
end
---@return nil
function CBaseEntity:recalculateStats()
end
---@nodiscard
---@return boolean
function CBaseEntity:checkImbuedItems()
end
---@nodiscard
---@return boolean
function CBaseEntity:isDualWielding()
end
---@nodiscard
---@return boolean
function CBaseEntity:isUsingH2H()
end
---@nodiscard
---@param slot integer
---@return integer
function CBaseEntity:getBaseWeaponDelay(slot)
end
---@nodiscard
---@return integer
function CBaseEntity:getBaseDelay()
end
---@nodiscard
---@return integer
function CBaseEntity:getBaseRangedDelay()
end
---@nodiscard
---@param damageType integer
---@return number
function CBaseEntity:checkLiementAbsorb(damageType)
end
---@nodiscard
---@param target CBaseEntity
---@return integer
function CBaseEntity:getCE(target)
end
---@nodiscard
---@param target CBaseEntity
---@return integer
function CBaseEntity:getVE(target)
end
---@param target CBaseEntity
---@param amount integer
---@return nil
function CBaseEntity:setCE(target, amount)
end
---@param target CBaseEntity
---@param amount integer
---@return nil
function CBaseEntity:setVE(target, amount)
end
2025-04-14 18:32:20 -06:00
---@param PEntity CBaseEntity
---@return nil
function CBaseEntity:addBaseEnmity(PEntity)
end
---@param PEntity CBaseEntity
---@param CE integer
---@param VE integer
---@return nil
function CBaseEntity:addEnmity(PEntity, CE, VE)
end
---@param PEntity CBaseEntity
---@param percent integer
---@return nil
function CBaseEntity:lowerEnmity(PEntity, percent)
end
---@param PEntity CBaseEntity
---@return nil
function CBaseEntity:updateEnmity(PEntity)
end
---@param entity CBaseEntity
---@param percent integer
---@param range number
---@return nil
function CBaseEntity:transferEnmity(entity, percent, range)
end
---@param PEntity CBaseEntity
---@param damage integer
---@return nil
function CBaseEntity:updateEnmityFromDamage(PEntity, damage)
end
---@param PEntity CBaseEntity
---@param amount integer
---@param fixedCE integer? Optional, Defaults to 0
---@param fixedVE integer? Optional, Defaults to 0
---@return nil
function CBaseEntity:updateEnmityFromCure(PEntity, amount, fixedCE, fixedVE)
end
---@param PEntity CBaseEntity
---@return nil
function CBaseEntity:resetEnmity(PEntity)
end
---@param PEntity CBaseEntity
---@param active boolean
---@return nil
function CBaseEntity:setEnmityActive(PEntity, active)
end
---@param entity CBaseEntity
---@return nil
function CBaseEntity:updateClaim(entity)
end
2025-02-27 23:59:35 +00:00
---@nodiscard
---@param entity CBaseEntity
---@return boolean
function CBaseEntity:hasClaim(entity)
end
---@nodiscard
---@return boolean
function CBaseEntity:hasEnmity()
end
---@nodiscard
---@return table
function CBaseEntity:getNotorietyList()
end
---@nodiscard
---@param rangeOverride number? Optional, Defaults to 22
---@return CBaseEntity?
function CBaseEntity:getMasterThreatMob(rangeOverride)
end
---@param PEntity CBaseEntity
---@return nil
function CBaseEntity:clearEnmityForEntity(PEntity)
end
2026-02-19 20:46:49 -07:00
---@class StatusEffectParams
---@field origin CBaseEntity
2026-02-19 22:48:02 -07:00
---@field power number?
---@field duration number?
---@field tick number?
---@field icon xi.effect? Defaults to effectId if not set
2026-02-19 20:46:49 -07:00
---@field subType integer?
2026-02-19 22:48:02 -07:00
---@field subPower number?
---@field subIcon? xi.effect? Defaults to effectId if not set
2026-02-19 20:46:49 -07:00
---@field tier integer?
---@field flag xi.effectFlag?
---@field sourceType xi.effectSourceType?
---@field sourceTypeParam integer?
---@field silent boolean?
---@param effectId xi.effect
---@param params StatusEffectParams
---@return boolean
function CBaseEntity:addStatusEffect(effectId, params)
end
---@param effect CStatusEffect
---@return boolean
2026-02-19 20:46:49 -07:00
function CBaseEntity:copyStatusEffect(effect)
end
---@nodiscard
---@param StatusID integer
---@param SubType integer?
---@return CStatusEffect?
function CBaseEntity:getStatusEffect(StatusID, SubType)
end
---@nodiscard
---@param StatusID integer
---@param SourceType integer
---@param SourceTypeParam integer
---@return CStatusEffect?
function CBaseEntity:getStatusEffectBySource(StatusID, SourceType, SourceTypeParam)
end
---@nodiscard
---@return CStatusEffect[]
function CBaseEntity:getStatusEffects()
end
---@nodiscard
---@param statusId integer
---@return integer
function CBaseEntity:getStatusEffectElement(statusId)
end
---@nodiscard
---@param effect integer
---@param powerObj integer?
---@return boolean
function CBaseEntity:canGainStatusEffect(effect, powerObj)
end
---@nodiscard
---@param StatusID integer
---@param SubType integer?
function CBaseEntity:hasStatusEffect(StatusID, SubType)
end
---@nodiscard
---@param StatusID integer
---@return boolean
function CBaseEntity:hasStatusEffectByFlag(StatusID)
end
---@nodiscard
---@param StatusID integer
---@return integer
function CBaseEntity:countEffect(StatusID)
end
---@nodiscard
---@param flag integer
---@return integer
function CBaseEntity:countEffectWithFlag(flag)
end
---@param StatusID integer
---@param SubType integer?
---@param SourceType integer?
---@param SourceTypeParam integer?
---@return boolean
function CBaseEntity:delStatusEffect(StatusID, SubType, SourceType, SourceTypeParam)
end
---@param flag integer
---@param silent boolean?
---@return nil
function CBaseEntity:delStatusEffectsByFlag(flag, silent)
end
2026-06-11 11:37:58 -06:00
---@param type xi.effectType
---@return nil
function CBaseEntity:delStatusEffectsByType(type)
end
---@param StatusID integer
---@return boolean
function CBaseEntity:delStatusEffectSilent(StatusID)
end
---@return integer
function CBaseEntity:eraseStatusEffect()
end
---@return integer
function CBaseEntity:eraseAllStatusEffect()
end
---@param flagObj integer?
---@return integer
function CBaseEntity:dispelStatusEffect(flagObj)
end
---@param flagObj integer?
---@return integer
function CBaseEntity:dispelAllStatusEffect(flagObj)
end
---@param PTargetEntity CBaseEntity
---@param flagObj integer?
2025-04-15 01:54:14 -06:00
---@param silentObj boolean?
---@return integer
2025-04-15 01:54:14 -06:00
function CBaseEntity:stealStatusEffect(PTargetEntity, flagObj, silentObj)
end
---@param type integer
---@param amount integer
---@return nil
function CBaseEntity:addMod(type, amount)
end
---@nodiscard
---@param modID integer
---@return integer
function CBaseEntity:getMod(modID)
end
---@param modID integer
---@param value integer
---@return nil
function CBaseEntity:setMod(modID, value)
end
---@param modID integer
---@param value integer
---@return nil
function CBaseEntity:delMod(modID, value)
end
---@return nil
function CBaseEntity:printAllMods(modID, value)
end
---@nodiscard
---@param modId integer
---@return integer
function CBaseEntity:getMaxGearMod(modId)
end
---@nodiscard
---@param slot xi.slot
---@param modId integer
---@return integer
function CBaseEntity:getGearModFromSlot(slot, modId)
end
---@param condID integer
---@param conditionValue integer
---@param mID integer
---@param modValue integer
---@return nil
function CBaseEntity:addLatent(condID, conditionValue, mID, modValue)
end
---@param condID integer
---@param conditionValue integer
---@param mID integer
---@param modValue integer
---@return nil
function CBaseEntity:delLatent(condID, conditionValue, mID, modValue)
end
---@nodiscard
---@param slot integer
---@return boolean
function CBaseEntity:hasAllLatentsActive(slot)
end
---@return nil
function CBaseEntity:fold()
end
---@param PEntity CBaseEntity
---@param total integer
---@return nil
function CBaseEntity:doWildCard(PEntity, total)
end
---@nodiscard
---@param PTarget CBaseEntity
---@return boolean
function CBaseEntity:doRandomDeal(PTarget)
end
---@nodiscard
---@param casterJob integer
---@param bustDuration integer
---@param effectID integer
---@param power integer
---@param tick integer
---@param duration integer
---@param subType integer
---@param subPower integer
---@param tier integer
---@param sourceType integer
---@param sourceTypeParam integer
---@param originID integer
---@return boolean
function CBaseEntity:addCorsairRoll(casterJob, bustDuration, effectID, power, tick, duration, subType, subPower, tier, sourceType, sourceTypeParam, originID)
end
---@nodiscard
---@return boolean
function CBaseEntity:hasCorsairEffect()
end
---@nodiscard
---@param id integer
---@return boolean
function CBaseEntity:hasBustEffect(id)
end
---@nodiscard
---@return integer
function CBaseEntity:numBustEffects()
end
---@return integer
function CBaseEntity:healingWaltz()
end
---@nodiscard
---@param PEntity CBaseEntity
---@param effectID integer
---@param power integer
---@param tick integer
---@param duration integer
---@param SubType integer
---@param subPower integer
---@param tier integer
---@return boolean
function CBaseEntity:addBardSong(PEntity, effectID, power, tick, duration, SubType, subPower, tier)
end
---@param target CBaseEntity
---@param p0 integer?
---@return nil
function CBaseEntity:charm(target, p0)
end
---@return nil
function CBaseEntity:uncharm()
end
2025-08-16 23:43:40 -06:00
---@nodiscard
---@return boolean
function CBaseEntity:isCharmed()
end
---@nodiscard
---@return boolean
function CBaseEntity:isTandemActive()
end
---@nodiscard
---@param element integer
---@param burden integer
---@return integer
function CBaseEntity:addBurden(element, burden)
end
---@nodiscard
---@param element integer
---@return integer
function CBaseEntity:getOverloadChance(element)
end
---@param statDebil integer
---@return nil
function CBaseEntity:setStatDebilitation(statDebil)
end
---@nodiscard
---@param statId integer
---@param optSlot integer?
---@return integer
function CBaseEntity:getStat(statId, optSlot)
end
---@nodiscard
---@param maybeAttackNumber integer?
---@return integer
function CBaseEntity:getACC(maybeAttackNumber)
end
---@nodiscard
---@return integer
function CBaseEntity:getEVA()
end
---@nodiscard
---@return integer
function CBaseEntity:getRACC()
end
---@nodiscard
---@return integer
function CBaseEntity:getRATT()
end
---@nodiscard
---@return integer
function CBaseEntity:getIlvlMacc()
end
---@nodiscard
---@return integer
function CBaseEntity:getIlvlSkill()
end
---@nodiscard
---@return integer
function CBaseEntity:getIlvlParry()
end
---@nodiscard
---@param damage number
---@param damageType integer?
---@return integer
function CBaseEntity:physicalDmgTaken(damage, damageType)
end
---@nodiscard
---@param damage number
---@param damageType integer?
---@return integer
function CBaseEntity:rangedDmgTaken(damage, damageType)
end
---@param damage number
---@return nil
function CBaseEntity:handleAfflatusMiseryDamage(damage)
end
---@nodiscard
---@return boolean
function CBaseEntity:isWeaponTwoHanded()
end
---@nodiscard
---@return integer
function CBaseEntity:getWeaponDmg()
end
---@nodiscard
---@return integer
function CBaseEntity:getWeaponDmgRank()
end
---@nodiscard
---@return integer
function CBaseEntity:getOffhandDmg()
end
---@nodiscard
---@return integer
function CBaseEntity:getOffhandDmgRank()
end
---@nodiscard
---@return integer
function CBaseEntity:getRangedDmg()
end
---@nodiscard
---@return integer
function CBaseEntity:getRangedDmgRank()
end
---@nodiscard
---@return integer
function CBaseEntity:getAmmoDmg()
end
---@nodiscard
---@return integer
function CBaseEntity:getWeaponHitCount(offhand)
end
2025-04-26 18:43:20 -06:00
---@nodiscard
---@return integer
function CBaseEntity:addDamageFromMultipliers(damage, attackType, weaponSlot, allowProc)
end
---@return nil
---@param ammoUsed integer
function CBaseEntity:removeAmmo(ammoUsed)
end
---@nodiscard
---@param slotID integer
---@return integer
function CBaseEntity:getWeaponSkillLevel(slotID)
end
---@nodiscard
---@param slotID integer
---@return integer
function CBaseEntity:getWeaponDamageType(slotID)
end
---@nodiscard
---@param slotID integer
---@return integer
function CBaseEntity:getWeaponSkillType(slotID)
end
---@nodiscard
---@param slotID integer
---@return integer
function CBaseEntity:getWeaponSubSkillType(slotID)
end
---@nodiscard
---@return table
function CBaseEntity:getWSSkillchainProp()
end
---@nodiscard
---@param attacker CBaseEntity
---@param damage integer
---@param atkType integer
---@param dmgType integer
---@param slot integer
---@param primary boolean
---@param tpMultiplier number
---@param bonusTP integer
---@param targetTPMultiplier number
---@return integer
function CBaseEntity:takeWeaponskillDamage(attacker, damage, atkType, dmgType, slot, primary, tpMultiplier, bonusTP, targetTPMultiplier)
end
---@param caster CBaseEntity
---@param spell CSpell
---@param damage integer
---@param atkType integer
---@param dmgType integer
---@return nil
function CBaseEntity:takeSpellDamage(caster, spell, damage, atkType, dmgType)
end
---@nodiscard
---@param caster CBaseEntity
---@param damage integer
---@param atkType integer
---@param dmgType integer
---@return integer
function CBaseEntity:takeSwipeLungeDamage(caster, damage, atkType, dmgType)
end
---@nodiscard
---@param damage integer
---@return integer
function CBaseEntity:checkDamageCap(damage)
end
---@nodiscard
---@param damage integer
---@param isPhysical boolean
---@return integer
function CBaseEntity:handleSevereDamage(damage, isPhysical)
end
---@param arg0 integer? Optional Pet ID
---@return nil
function CBaseEntity:spawnPet(arg0)
end
---@return nil
function CBaseEntity:despawnPet()
end
---@param trustId integer
---@return CBaseEntity?
function CBaseEntity:spawnTrust(trustId)
end
---@return nil
function CBaseEntity:clearTrusts()
end
---@nodiscard
---@return integer
function CBaseEntity:getTrustID()
end
---@param messageId integer
---@return nil
function CBaseEntity:trustPartyMessage(messageId)
end
---@param targ integer
---@param conditions table
---@param reactions table
---@param retry integer?
---@return string
function CBaseEntity:addGambit(targ, conditions, reactions, retry)
end
---@param id string
---@return nil
function CBaseEntity:removeGambit(id)
end
---@return nil
function CBaseEntity:removeAllGambits()
end
---@param trigger integer
---@param select integer
---@param value integer?
---@return nil
function CBaseEntity:setTrustTPSkillSettings(trigger, select, value)
end
---@nodiscard
---@return boolean
function CBaseEntity:hasPet()
end
---@nodiscard
---@return boolean
function CBaseEntity:hasJugPet()
end
---@nodiscard
---@return CBaseEntity?
function CBaseEntity:getPet()
end
---@nodiscard
---@return integer
function CBaseEntity:getPetID()
end
---@nodiscard
---@return boolean
function CBaseEntity:isAutomaton()
end
---@nodiscard
---@return boolean
function CBaseEntity:isAvatar()
end
---@nodiscard
---@return boolean
function CBaseEntity:isJugPet()
end
---@nodiscard
---@return CBaseEntity?
function CBaseEntity:getMaster()
end
---@nodiscard
---@return integer
function CBaseEntity:getPetElement()
end
---@param petObj CBaseEntity?
---@return nil
function CBaseEntity:setPet(petObj)
end
---@nodiscard
---@return integer
function CBaseEntity:getMinimumPetLevel()
end
---@nodiscard
---@return string
function CBaseEntity:getPetName()
end
---@param pType integer
---@param value integer
---@param arg2 integer?
---@return nil
function CBaseEntity:setPetName(pType, value, arg2)
end
---@param color xi.chocobo.color
---@param traits table
---@return nil
function CBaseEntity:registerChocobo(color, traits)
end
---@nodiscard
---@param target CBaseEntity
---@param mods boolean?
---@return number
function CBaseEntity:getCharmChance(target, mods)
end
---@param target CBaseEntity
---@return nil
function CBaseEntity:charmPet(target)
end
---@param PEntity CBaseEntity
---@return nil
function CBaseEntity:petAttack(PEntity)
end
---@param abilityID integer
---@return nil
function CBaseEntity:petAbility(abilityID)
end
---@return nil
function CBaseEntity:petRetreat()
end
---@return nil
function CBaseEntity:familiar()
end
---@param modID integer
---@param amount integer
---@return nil
function CBaseEntity:addPetMod(modID, amount)
end
---@param modID integer
---@param amount integer
---@return nil
function CBaseEntity:setPetMod(modID, amount)
end
---@param modID integer
---@param amount integer
---@return nil
function CBaseEntity:delPetMod(modID, amount)
end
---@nodiscard
---@param itemID integer
---@return boolean
function CBaseEntity:hasAttachment(itemID)
end
2026-05-27 15:46:51 -06:00
---@nodiscard
---@param itemID integer
---@return boolean
function CBaseEntity:hasAttachmentSet(itemID)
end
---@nodiscard
---@return string
function CBaseEntity:getAutomatonName()
end
---@nodiscard
---@return xi.automaton.frame?
function CBaseEntity:getAutomatonFrame()
end
---@nodiscard
---@param frame xi.automaton.frame
---@return nil
function CBaseEntity:setAutomatonFrame(frame)
end
---@nodiscard
---@return xi.automaton.head?
function CBaseEntity:getAutomatonHead()
end
---@nodiscard
---@param head xi.automaton.head
---@return nil
function CBaseEntity:setAutomatonHead(head)
end
---@param itemID integer
---@return boolean
function CBaseEntity:unlockAttachment(itemID)
end
---@nodiscard
---@return integer
function CBaseEntity:getActiveManeuverCount()
end
---@return nil
function CBaseEntity:removeOldestManeuver()
end
---@return nil
function CBaseEntity:removeAllManeuvers()
end
---@param itemId integer
---@param slotId integer
---@return nil
function CBaseEntity:setAttachment(itemId, slotId)
end
---@nodiscard
---@return table
function CBaseEntity:getAttachments()
end
---@return nil
function CBaseEntity:updateAttachments()
end
---@param percentReduction number
---@param intReductionObj integer?
---@return nil
function CBaseEntity:reduceBurden(percentReduction, intReductionObj)
end
---@nodiscard
---@return boolean
function CBaseEntity:isExceedingElementalCapacity()
end
---@nodiscard
---@return table
function CBaseEntity:getAllRuneEffects()
end
---@nodiscard
---@return integer
function CBaseEntity:getActiveRuneCount()
end
---@nodiscard
---@return integer
function CBaseEntity:getHighestRuneEffect()
end
---@nodiscard
---@return integer
function CBaseEntity:getNewestRuneEffect()
end
---@return nil
function CBaseEntity:removeOldestRune()
end
---@return nil
function CBaseEntity:removeNewestRune()
end
---@return nil
function CBaseEntity:removeAllRunes()
end
---@param level integer
---@param recover boolean?
---@return nil
function CBaseEntity:setMobLevel(level, recover)
end
---@nodiscard
---@param statType integer
---@return integer
function CBaseEntity:getStatRank(statType)
end
---@param statType integer
---@param rank integer
---@return nil
function CBaseEntity:setStatRank(statType, rank)
end
---@nodiscard
---@return integer
function CBaseEntity:getEcosystem()
end
---@nodiscard
---@return integer
function CBaseEntity:getFamily()
end
---@nodiscard
---@return integer
function CBaseEntity:getSpecies()
end
---@nodiscard
---@param mobType integer
---@return boolean
function CBaseEntity:isMobType(mobType)
end
---@nodiscard
---@return boolean
function CBaseEntity:isUndead()
end
---@nodiscard
---@return boolean
function CBaseEntity:isNM()
end
---@nodiscard
---@return integer
function CBaseEntity:getModelSize()
end
---@param newSize number
---@return nil
function CBaseEntity:setModelSize(newSize)
end
---@nodiscard
---@return number
function CBaseEntity:getHitboxSize()
end
---@param newSize number
---@return nil
function CBaseEntity:setHitboxSize(newSize)
end
---@nodiscard
---@param target CBaseEntity
---@return number
function CBaseEntity:getMeleeRange(target)
end
---@param flags integer
---@param mobId integer?
---@return nil
function CBaseEntity:setMobFlags(flags, mobId)
end
---@nodiscard
---@return integer
function CBaseEntity:getMobFlags()
end
---@param flags integer
---@return nil
function CBaseEntity:setNpcFlags(flags)
end
---@param alwaysRelevant boolean
---@return nil
function CBaseEntity:setNpcAlwaysRelevant(alwaysRelevant)
end
---@param despawnSec integer?
---@param respawnSec integer?
---@return nil
function CBaseEntity:spawn(despawnSec, respawnSec)
end
---@nodiscard
---@return boolean
function CBaseEntity:isSpawned()
end
---@nodiscard
---@return table
function CBaseEntity:getSpawnPos()
end
---@param x number
---@param y number
---@param z number
---@param rot integer?
---@return nil
function CBaseEntity:setSpawn(x, y, z, rot)
end
---@nodiscard
---@return integer
function CBaseEntity:getRespawnTime()
end
---@param seconds integer
---@return nil
function CBaseEntity:setRespawnTime(seconds)
end
---@param groupID integer
---@return nil
function CBaseEntity:instantiateMob(groupID)
end
---@nodiscard
---@param traitID integer
---@return boolean
function CBaseEntity:hasTrait(traitID)
end
---@nodiscard
---@param immunityID integer
---@return boolean
function CBaseEntity:hasImmunity(immunityID)
end
---@param immunityID integer
---@return nil
function CBaseEntity:addImmunity(immunityID)
end
---@param immunityID integer
---@return nil
function CBaseEntity:delImmunity(immunityID)
end
---@param agressive boolean
---@return nil
function CBaseEntity:setAggressive(agressive)
end
---@param truedetection boolean
---@return nil
function CBaseEntity:setTrueDetection(truedetection)
end
---@param unkillable boolean
---@return nil
function CBaseEntity:setUnkillable(unkillable)
end
---@param untargetable boolean
---@return nil
function CBaseEntity:setUntargetable(untargetable)
end
---@nodiscard
---@return boolean
function CBaseEntity:getUntargetable()
end
---@param isAggroable boolean
---@return nil
function CBaseEntity:setIsAggroable(isAggroable)
end
---@nodiscard
---@return boolean
function CBaseEntity:isAggroable()
end
---@param delay integer
---@return nil
function CBaseEntity:setDelay(delay)
end
---@param damage integer
---@return nil
function CBaseEntity:setDamage(damage)
end
2025-07-29 23:21:46 -06:00
---@nodiscard
---@return integer
function CBaseEntity:getSpellListId()
end
---@nodiscard
---@return boolean
function CBaseEntity:hasSpellList()
end
2025-07-29 23:21:46 -06:00
---@param spellListId integer
---@return nil
2025-07-29 23:21:46 -06:00
function CBaseEntity:setSpellList(spellListId)
end
---@param state boolean
---@return nil
function CBaseEntity:setAutoAttackEnabled(state)
end
---@param state boolean
---@return nil
function CBaseEntity:setRangedAttackEnabled(state)
end
---@nodiscard
---@return boolean
function CBaseEntity:isRangedAttackEnabled()
end
---@param state boolean
---@return nil
function CBaseEntity:setMagicCastingEnabled(state)
end
---@param state boolean
---@return nil
function CBaseEntity:setMobAbilityEnabled(state)
end
---@param listId integer
---@return nil
function CBaseEntity:setMobSkillAttack(listId)
end
---@nodiscard
---@param mobModID integer
---@return integer
function CBaseEntity:getMobMod(mobModID)
end
---@param mobModID integer
---@param value integer
---@return nil
function CBaseEntity:setMobMod(mobModID, value)
end
---@param mobModID integer
---@param value integer
---@return nil
function CBaseEntity:addMobMod(mobModID, value)
end
---@param mobModID integer
---@param value integer
---@return nil
function CBaseEntity:delMobMod(mobModID, value)
end
---@nodiscard
---@return integer
function CBaseEntity:getBattleTime()
end
2025-08-16 23:43:40 -06:00
---@nodiscard
2026-05-26 07:28:41 -06:00
---@return xi.element
2025-08-16 23:43:40 -06:00
function CBaseEntity:getCrystalElement()
end
2026-05-26 07:28:41 -06:00
---@param element xi.element
---@return nil
function CBaseEntity:setCrystalElement(element)
end
---@nodiscard
---@return integer
function CBaseEntity:getBehavior()
end
---@param behavior integer
---@return nil
function CBaseEntity:setBehavior(behavior)
end
---@nodiscard
---@return integer
function CBaseEntity:getRoamFlags()
end
---@param newRoamFlags integer
---@return nil
function CBaseEntity:setRoamFlags(newRoamFlags)
end
---@nodiscard
---@return CBaseEntity?
function CBaseEntity:getTarget()
end
---@return nil
function CBaseEntity:updateTarget()
end
---@nodiscard
---@return table
function CBaseEntity:getEnmityList()
end
---@nodiscard
---@param PLuaBaseEntity CBaseEntity
---@return CBaseEntity?
function CBaseEntity:getTrickAttackChar(PLuaBaseEntity)
end
---@nodiscard
---@return boolean
function CBaseEntity:actionQueueEmpty()
end
---@param spell integer?
---@param entity CBaseEntity?
---@return nil
function CBaseEntity:castSpell(spell, entity)
end
---@param skillID integer
---@param pet CBaseEntity?
---@return nil
function CBaseEntity:useJobAbility(skillID, pet)
end
---@param skillID integer
---@param PLuaBaseEntity CBaseEntity?
---@param castTimeOverride number?
---@param ignoreDistance boolean?
---@return nil
function CBaseEntity:useMobAbility(skillID, PLuaBaseEntity, castTimeOverride, ignoreDistance)
end
---@return nil
function CBaseEntity:useMobAbility()
end
---@param skillId integer
---@param PLuaBaseEntity CBaseEntity?
---@return nil
function CBaseEntity:usePetAbility(skillId, PLuaBaseEntity)
end
---@nodiscard
---@param skillID integer
---@return number
function CBaseEntity:getAbilityDistance(skillID)
end
---@nodiscard
---@return boolean
function CBaseEntity:hasTPMoves()
end
---@param PLuaBaseEntity CBaseEntity
2025-01-19 15:12:39 -07:00
---@param offset integer
---@param degrees integer
2025-11-25 11:15:26 -07:00
---@param position table
---@return nil
2025-11-25 11:15:26 -07:00
function CBaseEntity:drawIn(PLuaBaseEntity, offset, degrees, position)
end
---@return nil
function CBaseEntity:drawIn()
end
---@param level integer
---@return nil
function CBaseEntity:weaknessTrigger(level)
end
---@param PLuaBaseEntity CBaseEntity
---@param restoreType integer
---@return nil
function CBaseEntity:restoreFromChest(PLuaBaseEntity, restoreType)
end
---@nodiscard
---@return boolean
function CBaseEntity:hasPreventActionEffect()
end
---@param milliseconds integer
---@return nil
function CBaseEntity:stun(milliseconds)
end
---@param milliseconds integer
---@return nil
function CBaseEntity:untargetableAndUnactionable(milliseconds)
end
---@param attacker CBaseEntity
---@return nil
function CBaseEntity:tryHitInterrupt(attacker)
end
---@nodiscard
---@return integer
function CBaseEntity:getPool()
end
---@nodiscard
---@return integer
function CBaseEntity:getDropID()
end
---@param dropID integer
---@return nil
function CBaseEntity:setDropID(dropID)
end
---@param itemID integer
---@param arg1 CBaseEntity?
---@param arg2 integer?
---@return nil
function CBaseEntity:addTreasure(itemID, arg1, arg2)
end
2025-03-04 04:52:06 -07:00
---@nodiscard
---@return CTreasurePool?
function CBaseEntity:getTreasurePool()
end
---@nodiscard
---@return integer
function CBaseEntity:getStealItem()
end
---@nodiscard
---@return integer
function CBaseEntity:getDespoilItem()
end
---@nodiscard
---@param itemID integer
---@return integer
function CBaseEntity:getDespoilDebuff(itemID)
end
---@param stolen boolean
---@return nil
function CBaseEntity:itemStolen(stolen)
end
---@param despoiled boolean
---@return nil
function CBaseEntity:itemDespoiled(despoiled)
end
---@nodiscard
---@return integer
function CBaseEntity:getTHlevel()
end
---@nodiscard
---@param newLevel integer
---@return nil
function CBaseEntity:setTHlevel(newLevel)
end
---@nodiscard
---@return integer
function CBaseEntity:getAvailableTraverserStones()
end
---@nodiscard
---@return integer
function CBaseEntity:getTraverserEpoch()
end
---@return nil
function CBaseEntity:setTraverserEpoch()
end
---@nodiscard
---@return integer
function CBaseEntity:getClaimedTraverserStones()
end
---@param numStones integer
---@return nil
function CBaseEntity:addClaimedTraverserStones(numStones)
end
---@param totalStones integer
---@return nil
function CBaseEntity:setClaimedTraverserStones(totalStones)
end
---@nodiscard
---@param index integer
---@return integer
function CBaseEntity:getHistory(index)
end
---@nodiscard
---@return table
function CBaseEntity:getChocoboRaisingInfo()
end
---@param chocoboInfo table
---@return boolean
function CBaseEntity:setChocoboRaisingInfo(chocoboInfo)
end
---@return boolean
function CBaseEntity:deleteRaisedChocobo()
end
---@return nil
function CBaseEntity:clearActionQueue()
end
---@return nil
function CBaseEntity:clearTimerQueue()
end
---@param itemID integer
---@param race integer
---@param pose integer
---@return nil
function CBaseEntity:setMannequinPose(itemID, race, pose)
end
---@nodiscard
---@param itemID integer
---@return integer
function CBaseEntity:getMannequinPose(itemID)
end
---@param packetId integer
---@param offset integer
---@param value integer
---@return nil
function CBaseEntity:addPacketMod(packetId, offset, value)
end
---@return nil
function CBaseEntity:clearPacketMods()
end