AR/getAccountData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 11: Line 11:


===Required Arguments===  
===Required Arguments===  
*'''theAccount:''' The account you wish to retrieve the data from.
*'''theAccount:''' الحساب الذي يرغب في استرداد البيانات منه.
*'''key:''' The key under which the data is stored
*'''key:''' المفتاح الذي بموجبه يتم تخزين البيانات


===Returns===
===Returns===

Revision as of 22:03, 7 February 2015

Warning.png This page requires local translation. If page will remain not translated in reasonable period of time it would be deleted.
After translating the page completely, please remove the ‎{{translate}}‎ tag from the page.

This template is no longer in use as it results in poor readability. This function retrieves a string that has been stored using setAccountData. Data stored as account data is persistent across user's sessions and maps, unless they are logged into a guest account.

Syntax

string getAccountData ( account theAccount, string key )

Required Arguments

  • theAccount: الحساب الذي يرغب في استرداد البيانات منه.
  • key: المفتاح الذي بموجبه يتم تخزين البيانات

Returns

.بإرجاع سلسلة تحتوي على البيانات المخزنة أو خاطئة إذا تم تخزين أية بيانات تحت هذا المفتاح

Example

For a pirate roleplaying gametype, the amount of money a player has is made persistent by storing it in his account. Note the code uses "piraterpg.money" as key instead of just "money", as the player may be participating in other gametypes that also save his money amount to his account. If both gametypes would use "money" as the account key, they'd overwrite each other's data.

function onPlayerQuit()
      local playerAccount = getPlayerAccount(source) -- get his account
      if (playerAccount) then -- if we got the account then
            local playerMoney = getPlayerMoney(source) -- get his money amount
            setAccountData(playerAccount, "piraterpg.money", playerMoney) -- store his current money amount in his account data
      end
end
addEventHandler("onPlayerQuit", getRootElement(), onPlayerQuit) -- add an event handler

function onPlayerLogin()
      -- when a player logins, retrieve his money amount from his account data and set it
      local playerAccount = getPlayerAccount(source) -- get his account
      if (playerAccount) then -- if we got the account then
            local playerMoney = getAccountData(playerAccount, "piraterpg.money") -- get the money amount was store in his account data
            -- make sure there was actually a value saved under this key (check if playerMoney is not false).
            -- this will for example not be the case when a player plays the gametype for the first time
            if (playerMoney) then
                  setPlayerMoney(source, playerMoney)
            end
      end
end
addEventHandler("onPlayerLogin", getRootElement(), onPlayerLogin) -- add an event handler

See Also