llTransferLindenDollars

From Second Life Wiki
Revision as of 18:26, 11 January 2012 by Kireji Haiku (talk | contribs)
Jump to navigation Jump to search

Summary

Function: key llTransferLindenDollars( key destination, integer amount );

Transfer amount of L$ money from script owner to destination avatar.
Returns a key used in a matching transaction_result event for the success or failure of the transfer. If the transaction is successful, this key will show in the transaction history.

• key destination – avatar UUID
• integer amount – number of L$, must be greater than zero, (amount > 0)

To run this function the script must request the PERMISSION_DEBIT permission with llRequestPermissions and it must be granted by the owner. If you aren't going to use the return value or the resulting transaction_result event consider using llGiveMoney instead of this function.

Caveats

Permissions
  • Do not depend upon the auto-grant status of permissions. Always use the run_time_permissions event.
  • If the script lacks the permission PERMISSION_DEBIT, the script will shout an error on DEBUG_CHANNEL and the operation fails (but the script continues to run).
  • If PERMISSION_DEBIT is granted by anyone other than the owner, then when the function is called an error will be shouted on DEBUG_CHANNEL.
  • Once the PERMISSION_DEBIT permission is granted there is no way to revoke it except from inside the script (for example, with a new llRequestPermissions call) or the script is reset or deleted.
  • An object cannot pay another object.
  • Objects deeded to groups cannot give money (the permission cannot be granted).
  • Use is limited to 30 payments in a 30 second interval for all scripts owned by that resident on a region. Sustained overage will produce a script error and halt payments while the rate remains excessive. Historically, faster payments have failed intermittently.
  • Once a script has the PERMISSION_DEBIT permission it can empty an account of L$.
    • Fraud & theft are both Linden Lab violations and crimes. Misuse this function and you risk being banned and legal action. In addition LL may freeze the accounts of anyone the money is transferred to and restore it to it's rightful owners. This may involve retrieving it from third party exchanges and accounts on those exchanges being frozen. The system is not designed to be friendly towards fraud.

Examples

<lsl>/*

  • A simple piggy bank, anyone can pay in money and anyone can click it to get money out.
  • TO DO:
  • - handle different errors differently based upon CSV output
  • original by Strife Onizuka
  • modified by Kireji Haiku:
  • - because weird things happen in LSL when using more than one state
  • - one should say thanks when being payed
  • - added 0 L$ payment when bank is empty, to show failed payment notifications
  • - added target UUID and L$ amount into transaction history, too
  • /

integer hasBeenGrantedDebitPerms;

integer amountGivenAwayOnClick; integer totalLindenDollarsInBank;

list listOfTransactionRecords;

update_floattext() { 

   string floattext = "I have no L$ to give away :(";

   if (amountGivenAwayOnClick <= totalLindenDollarsInBank
       && hasBeenGrantedDebitPerms)
   {
       floattext = "I have L$ "+ (string)totalLindenDollarsInBank + " to give away!";
   }

   llSetText(floattext, <1.0, 1.0, 1.0>, (float)TRUE);

}

default { 

   on_rez(integer start_param)
   {
       llResetScript();
   }



   changed(integer change)
   {
       if (change & CHANGED_OWNER)
           llResetScript();
   }

   state_entry()
   {
       // how much money to give away each time?

       amountGivenAwayOnClick = 10;

       // how much money do we initially "have" in the bank?

       totalLindenDollarsInBank = 50;

       update_floattext();

       // request permissions to give away money, otherwise this won't work

       key owner = llGetOwner();
       llRequestPermissions(owner, PERMISSION_DEBIT);
   }

   touch_start(integer num_detected)
   {
       // if the script has been granted debit permissions
       if (hasBeenGrantedDebitPerms)
       {
           key id = llDetectedKey(0);

           // if we have at least as much money in the bank as we would be giving away
           if (amountGivenAwayOnClick <= totalLindenDollarsInBank)
           {
               // we add the transaction ID, the target avatar UUID and the L$ amount to a list
               listOfTransactionRecords += [llTransferLindenDollars(id, amountGivenAwayOnClick) + id + amountGivenAwayOnClick];

               // we take the money from the bank
               totalLindenDollarsInBank -= amountGivenAwayOnClick;
           }
           else
           {
               // will not work, cause paying 0 L$!
               // will send a "failed payment" notification!
               // only for DEMO purposes, usually you should do something like:
               // llSay(PUBLIC_CHANNEL, "Sorry, no money in the bank!");
               // instead !!!

               listOfTransactionRecords += [llTransferLindenDollars(id, 0) + id + 0];
           }
       }

       update_floattext();
   }

   money(key id, integer amount)
   {
       // someone payed the bank!

       totalLindenDollarsInBank += amount;

       update_floattext();

       // be nice, say thanks

       llInstantMessage(id, "Thanks a bunch!");
   }

   transaction_result(key id, integer success, string data)
   {
       integer index = llListFindList(listOfTransactionRecords, [id]);

       //if the ID was found in our list
       if (~index)
       {
           // if payment failed, give notice
           if (!success)
           {
               key targetUUID = llList2Key(listOfTransactionRecords, index + 1);
               integer amountNotPayed = llList2Integer(listOfTransactionRecords, index + 2);

               llSay(PUBLIC_CHANNEL, "\n \nSorry, somehow the transaction has failed!"
                   + "transaction ID: " + (string)id
                   + "\ntarget UUID: " + (string)targetUUID
                   + "\namount not payed: " + (string)amountNotPayed);

               // if the amount that wasn't payed is more than 0 L$, but the money back into the bank
               if (amountNotPayed)
                   totalLindenDollarsInBank += amountNotPayed;
           }

           // remove the entry again [transaction ID, target UUID, L$ amount]
           listOfTransactionRecords = llDeleteSubList(listOfTransactionRecords, index, index + 2);
       }
   }

   run_time_permissions (integer perm)
   {
       if(perm & PERMISSION_DEBIT)
           hasBeenGrantedDebitPerms = TRUE;

       update_floattext();
   }
}</lsl>

Notes

  • released on main server channel on 3-Dec-2011

See Also

Events

•  run_time_permissions – Permission receiving event
•  transaction_result
•  money

Functions

•  llGetPermissions – Get the permissions granted
•  llGetPermissionsKey – Get the agent who granted permissions
•  llRequestPermissions – Request permissions
•  llGiveMoney
•  llSetPayPrice

Articles

•  Script permissions

Deep Notes

Signature

function key llTransferLindenDollars( key destination, integer amount );
Retrieved from "https://wiki.secondlife.com/w/index.php?title=LlTransferLindenDollars&oldid=1161198"