net.tslat.aoa3.api.AoAPlayerAPI

可用函數的javadocs可以在http://tslat.net/Hosting/Tslat-AoA/javadocs找到。

如果某條為函數，則其後附帶()字樣。如果為對象，則為{}，否則不加符號後綴。

consumeResource()

作用	消耗指定玩家指定資源類型的資源值。如果 forceConsume = true ，建議先檢查玩家的資源值是否充足。 若沒有檢查且玩家並沒有剩餘足夠的資源值，函數可能會返回一個無法分辨的假結果。
參數	resource		String 指定資源名稱。資源名稱必須全大寫！
	amount		float 指定要消耗資源的值。允許的最小值為0。
	forceConsume		boolean 指定當玩家資源值不足時是否仍然消耗。
	player		EntityPlayer 指定目標玩家。
返回	boolean 代表函數是否成功執行。當forceConsume為true且指定資源資源值不足時，函數會將指定資源消耗至0並將之視為正常執行。 當函數無法找到指定資源或因其他原因出錯時返回false。

public static boolean consumeResource(String resource, float amount, boolean forceConsume, EntityPlayer player)

endRevenge()

作用	終止目標玩家的復仇。
參數	player	EntityPlayer 指定目標玩家。
返回	void 無

public static void endRevenge(EntityPlayer player)

getArmourSet()

作用	當適用時，返回目標玩家的盔甲盔甲名稱。 只會返回整套的盔甲的名稱，若包含有不屬於整套的盔甲將會出錯。
參數	player	EntityPlayer 指定目標玩家
返回	String 一個 @Nonnull (非空) 字符串對象，當適用時代表玩家當前的盔甲盔甲。任何其他情況都會返回空字符串。

public static String getArmourSet(EntityPlayer player)

getClientResourceValue()

作用	返回指定玩家指定資源的資源值。僅客戶端。客戶端的數據永遠沒有伺服器端的準確。
參數	resource	String 指定資源名稱。資源名稱必須全大寫！
返回	float 當前玩家指定資源的資源值。

@SideOnly(Side.CLIENT)
public static float getClientResourceValue(String resource)

getClientSkillLevel()

作用	返回當前玩家指定技能的等級。除非函數出錯，否則會返回介於（包括）1至1000之間的值。 本函數僅客戶端可用。
參數	skillName		String 指定技能名稱。技能名稱必須全大寫！
	includeVanityLevels		boolean to decide whether the method should return vanity levels or not. Also takes into account whether the player is currently viewing vanity levels.
返回	int 當前技能等級。當函數無法根據名稱找到目標技能或因其他因素導致函數出錯時返回-1。

@SideOnly(Side.CLIENT)
public static int getClientSkillLevel(String skillName, boolean includeVanityLevels)

getClientSkillXp()

作用	返回指定玩家指定技能的經驗值。僅客戶端可用。
參數	skillName	String 指定目標技能。技能名稱必須全大寫！
返回	float 代表指定玩家指定技能的經驗值的浮點數。當函數找不到目標技能或因其他原因出錯時返回-1。

@SideOnly(Side.CLIENT)
public static float getClientSkillXp(String skillName)

getCurrentlySelectedSkill()

作用	以字符串形式返回技能GUI中玩家當前選中的技能。如果沒有技能被選中，函數將會返回一個空字符串。 本函數僅在客戶端上可用。
參數	無
返回	String 當前選中的技能名稱，或是一個空字符串。

@SideOnly(Side.CLIENT)
public static String getCurrentlySelectedSkill()

getCurrentXp()

作用	返回指定玩家玩家指定技能當前等級所獲得的經驗值。當玩家升級後，返回值重置為0。
參數	skillName		String 指定技能名稱。技能名稱必須全大寫！
	player		EntityPlayer 指定目標玩家。
返回	float 返回指定玩家指定技能當前等級的所獲經驗值。當函數找不到技能或因其他原因出錯時返回-1。

public static float getCurrentXp(String skillName, EntityPlayer player)

getLevel()

作用	返回指定玩家指定技能的等級，當函數執行出錯時（比如找不到指定的技能）將會返回 -1 。
參數	skillName		String 指定技能名稱。技能名稱必須全大寫！
	player		EntityPlayer 指定目標玩家
返回	int 返回目標玩家目標技能的等級。當找不到指定技能或因其他原因出錯時返回-1。

public static int getLevel(String skillName, EntityPlayer player)

getPercentLevelComplete()

作用	返回一個代表目標玩家目標技能當前等級完成程度的百分整數。除非函數出錯，函數永遠會返回一個介於0~100的值(包含0與100)。 本函數僅在客戶端可用。
參數	skillName	String 指定目標技能。技能名稱必須全大寫！
返回	int 返回一個代表目標玩家目標技能當前等級完成程度的百分整數。當函數找不到指定技能名稱或因其他原因出錯時返回-1。

@SideOnly(Side.CLIENT)
public static int getPercentLevelComplete(String skillName)

getResourceValue()

作用	返回指定玩家指定資源的資源值。
參數	resource		String 指定資源名稱。資源名稱必須全大寫！
	player		EntityPlayer 指定目標玩家
返回	float 指定玩家指定資源類型的資源值。當函數無法找到指定資源或因其他原因出錯時返回-1。

public static float getResourceValue(String resource, EntityPlayer player)

getTributeValue()

作用	返回指定玩家指定神靈的祝福值。當無法找到神靈或者因其他原因導致出錯時返回-1。
參數	deityName		String 指定神靈名。神靈名稱必須全大寫！
	player		EntityPlayer 指定目標玩家。
返回	int 玩家當前祝福值。函數出錯時返回-1。

public static int getTributeValue(String deityName, EntityPlayer player)

getVulcanismTarget()

作用	當適用時返回復仇目標。
參數	player	EntityPlayer 指定目標玩家。
返回	EntityLivingBase 當前復仇目標。當目標未找到或因其他原因方式出錯時函數將返回null。

public static EntityLivingBase getVulcanismTarget(EntityPlayer player)

getXpToNextLevel()

作用	返回代表指定玩家指定技能升級所需的經驗值的浮點數。
參數	skillName		String 指定技能名稱。技能名稱必須全大寫！
	player		EntityPlayer 指定目標玩家。
返回	float 指定玩家指定技能升級所需的經驗值。當函數無法找到指定技能或者因其他原因出錯時返回-1。

public static float getXpToNextLevel(String skillName, EntityPlayer player)

regenResource()

作用	增加指定玩家的指定資源資源值。
參數	resource		String 指定資源名稱。資源名稱必須全大寫！
	amount		float 指定添加量。所允許的最小值為0。
	player		EntityPlayer 指定目標玩家。
返回	void 無

public static void regenResource(String resource, float amount, EntityPlayer player)

increaseTribute()

作用	增加指定玩家的祝福值。
參數	deityName		String 指定神靈名。神靈名稱必須全大寫！
	amount		int 指定要增加的值。 所允許的值範圍：0~200
	player		EntityPlayer 指定目標玩家。
返回	void 無

public static void increaseTribute(String deityName, int amount, EntityPlayer player)

setVulcanismTarget()

作用	為指定玩家設定復仇對象。
參數	target		EntityLivingBase 指定復仇目標。
	player		EntityPlayer 指定目標玩家。
返回	void 無

public static void setVulcanismTarget(EntityLivingBase target, EntityPlayer player)