Upstream/VaultAPI
1
0
Fork 0
mirror of https://github.com/MilkBowl/VaultAPI.git synced 2024-09-26 22:32:49 +02:00
Code Issues Projects Releases Wiki Activity
883b569213
VaultAPI/src-html/net/milkbowl/vault/economy/Economy.html

430 lines
33 KiB
HTML
Raw Normal View History

Latest javadoc on successful travis build 18 auto-pushed to gh-pages
2014-06-23 23:48:15 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/* This file is part of Vault.<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span> Vault is free software: you can redistribute it and/or modify<a name="line.3"></a>
<span class="sourceLineNo">004</span> it under the terms of the GNU Lesser General Public License as published by<a name="line.4"></a>
<span class="sourceLineNo">005</span> the Free Software Foundation, either version 3 of the License, or<a name="line.5"></a>
<span class="sourceLineNo">006</span> (at your option) any later version.<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span> Vault is distributed in the hope that it will be useful,<a name="line.8"></a>
<span class="sourceLineNo">009</span> but WITHOUT ANY WARRANTY; without even the implied warranty of<a name="line.9"></a>
<span class="sourceLineNo">010</span> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<a name="line.10"></a>
<span class="sourceLineNo">011</span> GNU Lesser General Public License for more details.<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span> You should have received a copy of the GNU Lesser General Public License<a name="line.13"></a>
<span class="sourceLineNo">014</span> along with Vault. If not, see &lt;http://www.gnu.org/licenses/&gt;.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package net.milkbowl.vault.economy;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.List;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.bukkit.OfflinePlayer;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
<span class="sourceLineNo">024</span> * The main economy API<a name="line.24"></a>
<span class="sourceLineNo">025</span> *<a name="line.25"></a>
<span class="sourceLineNo">026</span> */<a name="line.26"></a>
<span class="sourceLineNo">027</span>public interface Economy {<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span> /**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Checks if economy method is enabled.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * @return Success or Failure<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span> public boolean isEnabled();<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> /**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * Gets name of economy method<a name="line.36"></a>
<span class="sourceLineNo">037</span> * @return Name of Economy Method<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span> public String getName();<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Returns true if the given implementation supports banks.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @return true if the implementation supports banks<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span> public boolean hasBankSupport();<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Some economy plugins round off after a certain number of digits.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * This function returns the number of digits the plugin keeps<a name="line.49"></a>
<span class="sourceLineNo">050</span> * or -1 if no rounding occurs.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @return number of digits after the decimal point kept<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> public int fractionalDigits();<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Format amount into a human readable String This provides translation into<a name="line.56"></a>
<span class="sourceLineNo">057</span> * economy specific formatting to improve consistency between plugins. <a name="line.57"></a>
<span class="sourceLineNo">058</span> *<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @param amount to format<a name="line.59"></a>
<span class="sourceLineNo">060</span> * @return Human readable string describing amount<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span> public String format(double amount);<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> /**<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Returns the name of the currency in plural form.<a name="line.65"></a>
<span class="sourceLineNo">066</span> * If the economy being used does not support currency names then an empty string will be returned.<a name="line.66"></a>
<span class="sourceLineNo">067</span> * <a name="line.67"></a>
<span class="sourceLineNo">068</span> * @return name of the currency (plural)<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> public String currencyNamePlural();<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Returns the name of the currency in singular form.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * If the economy being used does not support currency names then an empty string will be returned.<a name="line.75"></a>
<span class="sourceLineNo">076</span> * <a name="line.76"></a>
<span class="sourceLineNo">077</span> * @return name of the currency (singular)<a name="line.77"></a>
<span class="sourceLineNo">078</span> */<a name="line.78"></a>
<span class="sourceLineNo">079</span> public String currencyNameSingular();<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
<span class="sourceLineNo">082</span> * <a name="line.82"></a>
<span class="sourceLineNo">083</span> * @deprecated As of VaultAPI 1.4 use {@link #hasAccount(OfflinePlayer)} instead.<a name="line.83"></a>
<span class="sourceLineNo">084</span> */<a name="line.84"></a>
<span class="sourceLineNo">085</span> @Deprecated<a name="line.85"></a>
<span class="sourceLineNo">086</span> public boolean hasAccount(String playerName);<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /**<a name="line.88"></a>
<span class="sourceLineNo">089</span> * Checks if this player has an account on the server yet<a name="line.89"></a>
<span class="sourceLineNo">090</span> * This will always return true if the player has joined the server at least once<a name="line.90"></a>
<span class="sourceLineNo">091</span> * as all major economy plugins auto-generate a player account when the player joins the server<a name="line.91"></a>
<span class="sourceLineNo">092</span> * <a name="line.92"></a>
<span class="sourceLineNo">093</span> * @param player to check<a name="line.93"></a>
<span class="sourceLineNo">094</span> * @return if the player has an account<a name="line.94"></a>
<span class="sourceLineNo">095</span> */<a name="line.95"></a>
<span class="sourceLineNo">096</span> public boolean hasAccount(OfflinePlayer player);<a name="line.96"></a>
<span class="sourceLineNo">097</span> <a name="line.97"></a>
<span class="sourceLineNo">098</span> /**<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @deprecated As of VaultAPI 1.4 use {@link #hasAccount(OfflinePlayer, String)} instead.<a name="line.99"></a>
<span class="sourceLineNo">100</span> */<a name="line.100"></a>
<span class="sourceLineNo">101</span> @Deprecated<a name="line.101"></a>
<span class="sourceLineNo">102</span> public boolean hasAccount(String playerName, String worldName);<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> /**<a name="line.104"></a>
<span class="sourceLineNo">105</span> * Checks if this player has an account on the server yet on the given world<a name="line.105"></a>
<span class="sourceLineNo">106</span> * This will always return true if the player has joined the server at least once<a name="line.106"></a>
<span class="sourceLineNo">107</span> * as all major economy plugins auto-generate a player account when the player joins the server<a name="line.107"></a>
<span class="sourceLineNo">108</span> * <a name="line.108"></a>
<span class="sourceLineNo">109</span> * @param player to check in the world<a name="line.109"></a>
<span class="sourceLineNo">110</span> * @param worldName world-specific account<a name="line.110"></a>
<span class="sourceLineNo">111</span> * @return if the player has an account<a name="line.111"></a>
<span class="sourceLineNo">112</span> */<a name="line.112"></a>
<span class="sourceLineNo">113</span> public boolean hasAccount(OfflinePlayer player, String worldName);<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> /**<a name="line.115"></a>
<span class="sourceLineNo">116</span> * @deprecated As of VaultAPI 1.4 use {@link #getBalance(OfflinePlayer)} instead.<a name="line.116"></a>
<span class="sourceLineNo">117</span> */<a name="line.117"></a>
<span class="sourceLineNo">118</span> @Deprecated<a name="line.118"></a>
<span class="sourceLineNo">119</span> public double getBalance(String playerName);<a name="line.119"></a>
<span class="sourceLineNo">120</span> <a name="line.120"></a>
<span class="sourceLineNo">121</span> /**<a name="line.121"></a>
<span class="sourceLineNo">122</span> * Gets balance of a player<a name="line.122"></a>
<span class="sourceLineNo">123</span> * <a name="line.123"></a>
<span class="sourceLineNo">124</span> * @param player of the player<a name="line.124"></a>
<span class="sourceLineNo">125</span> * @return Amount currently held in players account<a name="line.125"></a>
<span class="sourceLineNo">126</span> */<a name="line.126"></a>
<span class="sourceLineNo">127</span> public double getBalance(OfflinePlayer player);<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
<span class="sourceLineNo">130</span> * @deprecated As of VaultAPI 1.4 use {@link #getBalance(OfflinePlayer, String)} instead.<a name="line.130"></a>
<span class="sourceLineNo">131</span> */<a name="line.131"></a>
<span class="sourceLineNo">132</span> @Deprecated<a name="line.132"></a>
<span class="sourceLineNo">133</span> public double getBalance(String playerName, String world);<a name="line.133"></a>
<span class="sourceLineNo">134</span> <a name="line.134"></a>
<span class="sourceLineNo">135</span> /**<a name="line.135"></a>
<span class="sourceLineNo">136</span> * Gets balance of a player on the specified world.<a name="line.136"></a>
<span class="sourceLineNo">137</span> * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.<a name="line.137"></a>
<span class="sourceLineNo">138</span> * @param player to check<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @param world name of the world<a name="line.139"></a>
<span class="sourceLineNo">140</span> * @return Amount currently held in players account<a name="line.140"></a>
<span class="sourceLineNo">141</span> */<a name="line.141"></a>
<span class="sourceLineNo">142</span> public double getBalance(OfflinePlayer player, String world);<a name="line.142"></a>
<span class="sourceLineNo">143</span> <a name="line.143"></a>
<span class="sourceLineNo">144</span> /**<a name="line.144"></a>
<span class="sourceLineNo">145</span> * @deprecated As of VaultAPI 1.4 use {@link #has(OfflinePlayer, double)} instead.<a name="line.145"></a>
<span class="sourceLineNo">146</span> */<a name="line.146"></a>
<span class="sourceLineNo">147</span> @Deprecated<a name="line.147"></a>
<span class="sourceLineNo">148</span> public boolean has(String playerName, double amount);<a name="line.148"></a>
<span class="sourceLineNo">149</span> <a name="line.149"></a>
<span class="sourceLineNo">150</span> /**<a name="line.150"></a>
<span class="sourceLineNo">151</span> * Checks if the player account has the amount - DO NOT USE NEGATIVE AMOUNTS<a name="line.151"></a>
<span class="sourceLineNo">152</span> * <a name="line.152"></a>
<span class="sourceLineNo">153</span> * @param player to check<a name="line.153"></a>
<span class="sourceLineNo">154</span> * @param amount to check for<a name="line.154"></a>
<span class="sourceLineNo">155</span> * @return True if &lt;b&gt;player&lt;/b&gt; has &lt;b&gt;amount&lt;/b&gt;, False else wise<a name="line.155"></a>
<span class="sourceLineNo">156</span> */<a name="line.156"></a>
<span class="sourceLineNo">157</span> public boolean has(OfflinePlayer player, double amount);<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> /**<a name="line.159"></a>
<span class="sourceLineNo">160</span> * @deprecated As of VaultAPI 1.4 use @{link {@link #has(OfflinePlayer, String, double)} instead.<a name="line.160"></a>
<span class="sourceLineNo">161</span> */<a name="line.161"></a>
<span class="sourceLineNo">162</span> @Deprecated<a name="line.162"></a>
<span class="sourceLineNo">163</span> public boolean has(String playerName, String worldName, double amount);<a name="line.163"></a>
<span class="sourceLineNo">164</span> <a name="line.164"></a>
<span class="sourceLineNo">165</span> /**<a name="line.165"></a>
<span class="sourceLineNo">166</span> * Checks if the player account has the amount in a given world - DO NOT USE NEGATIVE AMOUNTS<a name="line.166"></a>
<span class="sourceLineNo">167</span> * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.<a name="line.167"></a>
<span class="sourceLineNo">168</span> * <a name="line.168"></a>
<span class="sourceLineNo">169</span> * @param player to check<a name="line.169"></a>
<span class="sourceLineNo">170</span> * @param worldName to check with<a name="line.170"></a>
<span class="sourceLineNo">171</span> * @param amount to check for<a name="line.171"></a>
<span class="sourceLineNo">172</span> * @return True if &lt;b&gt;player&lt;/b&gt; has &lt;b&gt;amount&lt;/b&gt;, False else wise<a name="line.172"></a>
<span class="sourceLineNo">173</span> */<a name="line.173"></a>
<span class="sourceLineNo">174</span> public boolean has(OfflinePlayer player, String worldName, double amount);<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> /**<a name="line.176"></a>
<span class="sourceLineNo">177</span> * @deprecated As of VaultAPI 1.4 use {@link #withdrawPlayer(OfflinePlayer, double)} instead.<a name="line.177"></a>
<span class="sourceLineNo">178</span> */<a name="line.178"></a>
<span class="sourceLineNo">179</span> @Deprecated<a name="line.179"></a>
<span class="sourceLineNo">180</span> public EconomyResponse withdrawPlayer(String playerName, double amount);<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> /**<a name="line.182"></a>
<span class="sourceLineNo">183</span> * Withdraw an amount from a player - DO NOT USE NEGATIVE AMOUNTS<a name="line.183"></a>
<span class="sourceLineNo">184</span> * <a name="line.184"></a>
<span class="sourceLineNo">185</span> * @param player to withdraw from<a name="line.185"></a>
<span class="sourceLineNo">186</span> * @param amount Amount to withdraw<a name="line.186"></a>
<span class="sourceLineNo">187</span> * @return Detailed response of transaction<a name="line.187"></a>
<span class="sourceLineNo">188</span> */<a name="line.188"></a>
<span class="sourceLineNo">189</span> public EconomyResponse withdrawPlayer(OfflinePlayer player, double amount);<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span> /**<a name="line.191"></a>
<span class="sourceLineNo">192</span> * @deprecated As of VaultAPI 1.4 use {@link #withdrawPlayer(OfflinePlayer, String, double)} instead.<a name="line.192"></a>
<span class="sourceLineNo">193</span> */<a name="line.193"></a>
<span class="sourceLineNo">194</span> @Deprecated<a name="line.194"></a>
<span class="sourceLineNo">195</span> public EconomyResponse withdrawPlayer(String playerName, String worldName, double amount);<a name="line.195"></a>
<span class="sourceLineNo">196</span> <a name="line.196"></a>
<span class="sourceLineNo">197</span> /**<a name="line.197"></a>
<span class="sourceLineNo">198</span> * Withdraw an amount from a player on a given world - DO NOT USE NEGATIVE AMOUNTS<a name="line.198"></a>
<span class="sourceLineNo">199</span> * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.<a name="line.199"></a>
<span class="sourceLineNo">200</span> * @param player to withdraw from<a name="line.200"></a>
<span class="sourceLineNo">201</span> * @param worldName - name of the world<a name="line.201"></a>
<span class="sourceLineNo">202</span> * @param amount Amount to withdraw<a name="line.202"></a>
<span class="sourceLineNo">203</span> * @return Detailed response of transaction<a name="line.203"></a>
<span class="sourceLineNo">204</span> */<a name="line.204"></a>
<span class="sourceLineNo">205</span> public EconomyResponse withdrawPlayer(OfflinePlayer player, String worldName, double amount);<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span> /**<a name="line.207"></a>
<span class="sourceLineNo">208</span> * @deprecated As of VaultAPI 1.4 use {@link #depositPlayer(OfflinePlayer, double)} instead.<a name="line.208"></a>
<span class="sourceLineNo">209</span> */<a name="line.209"></a>
<span class="sourceLineNo">210</span> @Deprecated<a name="line.210"></a>
<span class="sourceLineNo">211</span> public EconomyResponse depositPlayer(String playerName, double amount);<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span> /**<a name="line.213"></a>
<span class="sourceLineNo">214</span> * Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS<a name="line.214"></a>
<span class="sourceLineNo">215</span> * <a name="line.215"></a>
<span class="sourceLineNo">216</span> * @param player to deposit to<a name="line.216"></a>
<span class="sourceLineNo">217</span> * @param amount Amount to deposit<a name="line.217"></a>
<span class="sourceLineNo">218</span> * @return Detailed response of transaction<a name="line.218"></a>
<span class="sourceLineNo">219</span> */<a name="line.219"></a>
<span class="sourceLineNo">220</span> public EconomyResponse depositPlayer(OfflinePlayer player, double amount);<a name="line.220"></a>
<span class="sourceLineNo">221</span><a name="line.221"></a>
<span class="sourceLineNo">222</span> /**<a name="line.222"></a>
<span class="sourceLineNo">223</span> * @deprecated As of VaultAPI 1.4 use {@link #depositPlayer(OfflinePlayer, String, double)} instead.<a name="line.223"></a>
<span class="sourceLineNo">224</span> */<a name="line.224"></a>
<span class="sourceLineNo">225</span> @Deprecated<a name="line.225"></a>
<span class="sourceLineNo">226</span> public EconomyResponse depositPlayer(String playerName, String worldName, double amount);<a name="line.226"></a>
<span class="sourceLineNo">227</span> <a name="line.227"></a>
<span class="sourceLineNo">228</span> /**<a name="line.228"></a>
<span class="sourceLineNo">229</span> * Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS<a name="line.229"></a>
<span class="sourceLineNo">230</span> * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.<a name="line.230"></a>
<span class="sourceLineNo">231</span> * <a name="line.231"></a>
<span class="sourceLineNo">232</span> * @param player to deposit to<a name="line.232"></a>
<span class="sourceLineNo">233</span> * @param worldName name of the world<a name="line.233"></a>
<span class="sourceLineNo">234</span> * @param amount Amount to deposit<a name="line.234"></a>
<span class="sourceLineNo">235</span> * @return Detailed response of transaction<a name="line.235"></a>
<span class="sourceLineNo">236</span> */<a name="line.236"></a>
<span class="sourceLineNo">237</span> public EconomyResponse depositPlayer(OfflinePlayer player, String worldName, double amount);<a name="line.237"></a>
<span class="sourceLineNo">238</span><a name="line.238"></a>
<span class="sourceLineNo">239</span> /**<a name="line.239"></a>
<span class="sourceLineNo">240</span> * @deprecated As of VaultAPI 1.4 use {{@link #createBank(String, OfflinePlayer)} instead.<a name="line.240"></a>
<span class="sourceLineNo">241</span> */<a name="line.241"></a>
<span class="sourceLineNo">242</span> @Deprecated<a name="line.242"></a>
<span class="sourceLineNo">243</span> public EconomyResponse createBank(String name, String player);<a name="line.243"></a>
<span class="sourceLineNo">244</span><a name="line.244"></a>
<span class="sourceLineNo">245</span> /**<a name="line.245"></a>
<span class="sourceLineNo">246</span> * Creates a bank account with the specified name and the player as the owner<a name="line.246"></a>
<span class="sourceLineNo">247</span> * @param name of account<a name="line.247"></a>
<span class="sourceLineNo">248</span> * @param player the account should be linked to<a name="line.248"></a>
<span class="sourceLineNo">249</span> * @return EconomyResponse Object<a name="line.249"></a>
<span class="sourceLineNo">250</span> */<a name="line.250"></a>
<span class="sourceLineNo">251</span> public EconomyResponse createBank(String name, OfflinePlayer player);<a name="line.251"></a>
<span class="sourceLineNo">252</span><a name="line.252"></a>
<span class="sourceLineNo">253</span> /**<a name="line.253"></a>
<span class="sourceLineNo">254</span> * Deletes a bank account with the specified name.<a name="line.254"></a>
<span class="sourceLineNo">255</span> * @param name of the back to delete<a name="line.255"></a>
<span class="sourceLineNo">256</span> * @return if the operation completed successfully<a name="line.256"></a>
<span class="sourceLineNo">257</span> */<a name="line.257"></a>
<span class="sourceLineNo">258</span> public EconomyResponse deleteBank(String name);<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span> /**<a name="line.260"></a>
<span class="sourceLineNo">261</span> * Returns the amount the bank has<a name="line.261"></a>
<span class="sourceLineNo">262</span> * @param name of the account<a name="line.262"></a>
<span class="sourceLineNo">263</span> * @return EconomyResponse Object<a name="line.263"></a>
<span class="sourceLineNo">264</span> */<a name="line.264"></a>
<span class="sourceLineNo">265</span> public EconomyResponse bankBalance(String name);<a name="line.265"></a>
<span class="sourceLineNo">266</span><a name="line.266"></a>
<span class="sourceLineNo">267</span> /**<a name="line.267"></a>
<span class="sourceLineNo">268</span> * Returns true or false whether the bank has the amount specified - DO NOT USE NEGATIVE AMOUNTS<a name="line.268"></a>
<span class="sourceLineNo">269</span> * <a name="line.269"></a>
<span class="sourceLineNo">270</span> * @param name of the account<a name="line.270"></a>
<span class="sourceLineNo">271</span> * @param amount to check for<a name="line.271"></a>
<span class="sourceLineNo">272</span> * @return EconomyResponse Object<a name="line.272"></a>
<span class="sourceLineNo">273</span> */<a name="line.273"></a>
<span class="sourceLineNo">274</span> public EconomyResponse bankHas(String name, double amount);<a name="line.274"></a>
<span class="sourceLineNo">275</span><a name="line.275"></a>
<span class="sourceLineNo">276</span> /**<a name="line.276"></a>
<span class="sourceLineNo">277</span> * Withdraw an amount from a bank account - DO NOT USE NEGATIVE AMOUNTS<a name="line.277"></a>
<span class="sourceLineNo">278</span> * <a name="line.278"></a>
<span class="sourceLineNo">279</span> * @param name of the account<a name="line.279"></a>
<span class="sourceLineNo">280</span> * @param amount to withdraw<a name="line.280"></a>
<span class="sourceLineNo">281</span> * @return EconomyResponse Object<a name="line.281"></a>
<span class="sourceLineNo">282</span> */<a name="line.282"></a>
<span class="sourceLineNo">283</span> public EconomyResponse bankWithdraw(String name, double amount);<a name="line.283"></a>
<span class="sourceLineNo">284</span><a name="line.284"></a>
<span class="sourceLineNo">285</span> /**<a name="line.285"></a>
<span class="sourceLineNo">286</span> * Deposit an amount into a bank account - DO NOT USE NEGATIVE AMOUNTS<a name="line.286"></a>
<span class="sourceLineNo">287</span> * <a name="line.287"></a>
<span class="sourceLineNo">288</span> * @param name of the account<a name="line.288"></a>
<span class="sourceLineNo">289</span> * @param amount to deposit<a name="line.289"></a>
<span class="sourceLineNo">290</span> * @return EconomyResponse Object<a name="line.290"></a>
<span class="sourceLineNo">291</span> */<a name="line.291"></a>
<span class="sourceLineNo">292</span> public EconomyResponse bankDeposit(String name, double amount);<a name="line.292"></a>
<span class="sourceLineNo">293</span> <a name="line.293"></a>
<span class="sourceLineNo">294</span> /**<a name="line.294"></a>
<span class="sourceLineNo">295</span> * @deprecated As of VaultAPI 1.4 use {{@link #isBankOwner(String, OfflinePlayer)} instead.<a name="line.295"></a>
<span class="sourceLineNo">296</span> */<a name="line.296"></a>
<span class="sourceLineNo">297</span> @Deprecated<a name="line.297"></a>
<span class="sourceLineNo">298</span> public EconomyResponse isBankOwner(String name, String playerName);<a name="line.298"></a>
<span class="sourceLineNo">299</span> <a name="line.299"></a>
<span class="sourceLineNo">300</span> /**<a name="line.300"></a>
<span class="sourceLineNo">301</span> * Check if a player is the owner of a bank account<a name="line.301"></a>
<span class="sourceLineNo">302</span> * <a name="line.302"></a>
<span class="sourceLineNo">303</span> * @param name of the account<a name="line.303"></a>
<span class="sourceLineNo">304</span> * @param player to check for ownership<a name="line.304"></a>
<span class="sourceLineNo">305</span> * @return EconomyResponse Object<a name="line.305"></a>
<span class="sourceLineNo">306</span> */<a name="line.306"></a>
<span class="sourceLineNo">307</span> public EconomyResponse isBankOwner(String name, OfflinePlayer player);<a name="line.307"></a>
<span class="sourceLineNo">308</span><a name="line.308"></a>
<span class="sourceLineNo">309</span> /**<a name="line.309"></a>
<span class="sourceLineNo">310</span> * @deprecated As of VaultAPI 1.4 use {{@link #isBankMember(String, OfflinePlayer)} instead.<a name="line.310"></a>
<span class="sourceLineNo">311</span> */<a name="line.311"></a>
<span class="sourceLineNo">312</span> @Deprecated<a name="line.312"></a>
<span class="sourceLineNo">313</span> public EconomyResponse isBankMember(String name, String playerName);<a name="line.313"></a>
<span class="sourceLineNo">314</span> <a name="line.314"></a>
<span class="sourceLineNo">315</span> /**<a name="line.315"></a>
<span class="sourceLineNo">316</span> * Check if the player is a member of the bank account<a name="line.316"></a>
<span class="sourceLineNo">317</span> * <a name="line.317"></a>
<span class="sourceLineNo">318</span> * @param name of the account<a name="line.318"></a>
<span class="sourceLineNo">319</span> * @param player to check membership<a name="line.319"></a>
<span class="sourceLineNo">320</span> * @return EconomyResponse Object<a name="line.320"></a>
<span class="sourceLineNo">321</span> */<a name="line.321"></a>
<span class="sourceLineNo">322</span> public EconomyResponse isBankMember(String name, OfflinePlayer player);<a name="line.322"></a>
<span class="sourceLineNo">323</span><a name="line.323"></a>
<span class="sourceLineNo">324</span> /**<a name="line.324"></a>
<span class="sourceLineNo">325</span> * Gets the list of banks<a name="line.325"></a>
<span class="sourceLineNo">326</span> * @return the List of Banks<a name="line.326"></a>
<span class="sourceLineNo">327</span> */<a name="line.327"></a>
<span class="sourceLineNo">328</span> public List&lt;String&gt; getBanks();<a name="line.328"></a>
<span class="sourceLineNo">329</span><a name="line.329"></a>
<span class="sourceLineNo">330</span> /**<a name="line.330"></a>
<span class="sourceLineNo">331</span> * @deprecated As of VaultAPI 1.4 use {{@link #createPlayerAccount(OfflinePlayer)} instead.<a name="line.331"></a>
<span class="sourceLineNo">332</span> */<a name="line.332"></a>
<span class="sourceLineNo">333</span> @Deprecated<a name="line.333"></a>
<span class="sourceLineNo">334</span> public boolean createPlayerAccount(String playerName);<a name="line.334"></a>
<span class="sourceLineNo">335</span> <a name="line.335"></a>
<span class="sourceLineNo">336</span> /**<a name="line.336"></a>
<span class="sourceLineNo">337</span> * Attempts to create a player account for the given player<a name="line.337"></a>
<span class="sourceLineNo">338</span> * @param player OfflinePlayer<a name="line.338"></a>
<span class="sourceLineNo">339</span> * @return if the account creation was successful<a name="line.339"></a>
<span class="sourceLineNo">340</span> */<a name="line.340"></a>
<span class="sourceLineNo">341</span> public boolean createPlayerAccount(OfflinePlayer player);<a name="line.341"></a>
<span class="sourceLineNo">342</span> <a name="line.342"></a>
<span class="sourceLineNo">343</span> /**<a name="line.343"></a>
<span class="sourceLineNo">344</span> * @deprecated As of VaultAPI 1.4 use {{@link #createPlayerAccount(OfflinePlayer, String)} instead.<a name="line.344"></a>
<span class="sourceLineNo">345</span> */<a name="line.345"></a>
<span class="sourceLineNo">346</span> @Deprecated<a name="line.346"></a>
<span class="sourceLineNo">347</span> public boolean createPlayerAccount(String playerName, String worldName);<a name="line.347"></a>
<span class="sourceLineNo">348</span> <a name="line.348"></a>
<span class="sourceLineNo">349</span> /**<a name="line.349"></a>
<span class="sourceLineNo">350</span> * Attempts to create a player account for the given player on the specified world<a name="line.350"></a>
<span class="sourceLineNo">351</span> * IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.<a name="line.351"></a>
<span class="sourceLineNo">352</span> * @param player OfflinePlayer<a name="line.352"></a>
<span class="sourceLineNo">353</span> * @param worldName String name of the world<a name="line.353"></a>
<span class="sourceLineNo">354</span> * @return if the account creation was successful<a name="line.354"></a>
<span class="sourceLineNo">355</span> */<a name="line.355"></a>
<span class="sourceLineNo">356</span> public boolean createPlayerAccount(OfflinePlayer player, String worldName);<a name="line.356"></a>
<span class="sourceLineNo">357</span>}<a name="line.357"></a>
</pre>
</div>
</body>
</html>
Reference in New Issue Copy Permalink