https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetCultivationInfoAPI:GetCultivationInfo - Revision history2026-10-17T20:46:23ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetCultivationInfo&diff=30369&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:43:28Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Crafting}}<br />
Returns the state of one of the player's cultivation plots.<br />
<br />
<pre><br />
plot = GetCultivationInfo(plotNumber)<br />
</pre><br />
<br />
== Arguments ==<br />
;plotNumber : <code>number</code> – Plot number, starting at 1. It is rounded down.<br />
<br />
== Returns ==<br />
;plot : <code>table</code> – Plot table, see below.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>StageNum</code> || <code>number</code> || Growth stage, 0–5. 255 for an empty plot.<br />
|-<br />
| <code>TotalTimer</code> || <code>number</code> || Seconds left until the plant is done. 0 for an empty plot.<br />
|-<br />
| <code>StageTimer</code> || <code>number</code> || Seconds left in the current stage. 0 for an empty plot.<br />
|-<br />
| <code>Locked</code> || <code>boolean</code> || –<br />
|-<br />
| <code>Seed</code> || <code>table</code> || [[API:GetInventoryItemData#Item data table|Item data table]] of the planted seed. A blank item table for an empty plot.<br />
|-<br />
| <code>Additives</code> || <code>table</code> || Three item data tables with the keys '''2, 3 and 4''', one per additive type. The stock UI indexes it with <code>GameData.CultivationTypes.SOIL</code>, <code>WATERCAN</code> and <code>NUTRIENT</code>. Blank item tables for an empty plot.<br />
|-<br />
| <code>PlantName</code> || <code>wstring</code> || Name of the plant. In stages 4 and 5 this is the name the client received for the grown plant; in earlier stages it is the seed's name. <code>L""</code> for an empty plot.<br />
|-<br />
| <code>PlantCount</code> || <code>number</code> || In stages 4 and 5, the number received for the grown plant; in earlier stages 1. 0 for an empty plot.<br />
|}<br />
<br />
== Details ==<br />
* Timers are stored by the client in milliseconds and returned in whole seconds.<br />
* The data is what the client last received for the plot. The stock UI asks the server for fresh data with [[API:UpdateCraftingStatus|UpdateCraftingStatus]]<code>(3, 4, plotNumber)</code>.<br />
* The client does not range-check <code>plotNumber</code>. Use the plot numbers the stock UI uses (1 to <code>CultivationWindow.NUM_OF_PLOTS</code>).<br />
* If there is no player object or the Lua state is not available, nothing is returned.<br />
* Exactly one argument must be passed.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.<br />
<br />
== Example ==<br />
From <code>default/ea_cultivationwindow/source/cultivationwindow.lua</code>:<br />
<pre><br />
local plotData = GetCultivationInfo( plotNum )<br />
CultivationWindow.plot[plotNum] = plotData<br />
local stageInfo = CultivationWindow.stageInfo[plotData.StageNum]<br />
...<br />
elseif plotData.StageNum == 255<br />
then<br />
stageInfo = CultivationWindow.stageInfo[GameData.CultivationStage.EMPTY]<br />
</pre><br />
<br />
Checking the additives, from the same file:<br />
<pre><br />
WindowSetShowing( windowName.."SinglePlotNutrientIcon", plotData.Additives[GameData.CultivationTypes.NUTRIENT].id ~= 0 )<br />
WindowSetShowing( windowName.."SinglePlotWaterIcon", plotData.Additives[GameData.CultivationTypes.WATERCAN].id ~= 0 )<br />
WindowSetShowing( windowName.."SinglePlotSoilIcon", plotData.Additives[GameData.CultivationTypes.SOIL].id ~= 0 )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:UpdateCraftingStatus|UpdateCraftingStatus]]<br />
* [[API:AddCraftingItem|AddCraftingItem]]</div>Maintenance script