User withdrawPoints: Difference between revisions

Latest revision as of 09:32, 2 June 2020

int User_withdrawPoints(int points "Number of points to remove", string description "User visible log entry associated with the transaction") - Remove points from user of current QAS. Returns 0 if count not withdraw the necessary amount.
int User_withdrawPoints(int points "Number of points to remove", string description "User visible log entry associated with the transaction", int userResourceId "Resource Id of user that gets the points") - Remove custom points from user. Returns 0 if count not withdraw the necessary amount.
int User_withdrawPoints(int points "Number of points to remove", string description "User visible log entry associated with the transaction", int userResourceId "Resource Id of user that gets the points", int customType "Store custom transaction type. Can be 1-127, or 0 for ManualTransaction") - Remove custom points from user. Returns 0 if count not withdraw the necessary amount.

Example

number p = User_withdrawPoints(120, "Withdraw", 456546);
//return 0 or the number of withdrawn points

@@ Line 1: / Line 1: @@
 [[Category:User_Functions]]
-{{HelpFiles}}
+{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>User_withdrawPoints</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>points</nowiki>|Description=<nowiki>Number of points to remove</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>User visible log entry associated with the transaction</nowiki>}}
-====User_withdrawPoints====
+|InClass=<nowiki>User</nowiki>
+|Description=<nowiki>Remove points from user of current QAS. Returns 0 if count not withdraw the necessary amount.</nowiki>}}
-Withdraw a number of points from a user
+{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>User_withdrawPoints</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>points</nowiki>|Description=<nowiki>Number of points to remove</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>User visible log entry associated with the transaction</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource Id of user that gets the points</nowiki>}}
-'''Syntax'''
+|InClass=<nowiki>User</nowiki>
+|Description=<nowiki>Remove custom points from user. Returns 0 if count not withdraw the necessary amount.</nowiki>}}
-User_withdrawPoints(''points, description, userResourceId'')
+{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>User_withdrawPoints</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>points</nowiki>|Description=<nowiki>Number of points to remove</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>description</nowiki>|Description=<nowiki>User visible log entry associated with the transaction</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>userResourceId</nowiki>|Description=<nowiki>Resource Id of user that gets the points</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>customType</nowiki>|Description=<nowiki>Store custom transaction type. Can be 1-127, or 0 for ManualTransaction</nowiki>}}
-'''Arguments'''
+|InClass=<nowiki>User</nowiki>
+|Description=<nowiki>Remove custom points from user. Returns 0 if count not withdraw the necessary amount.</nowiki>}}
-* ''points'': is a ''number ''expression. It is the number of points to withdraw
-* ''description'': is a ''string ''expression. It is the transaction's description
-* ''userResourceId'': is a ''number ''expression. It is the user's resource id
-'''Return value'''
-A number, if the process succeeds, return 0, return the number of points otherwise
 '''Example'''
+<source lang="javascript">
-''number p = User_withdrawPoints(120, "Withdraw", 456546)'';
+number p = User_withdrawPoints(120, "Withdraw", 456546);
+//return 0 or the number of withdrawn points
-'''Availability'''
+</source>
-Version 5.6
-__NOTOC__
-<!-- imported from file: 6297.htm-->