Difference between revisions of "Queueremove"

From Hercules Wiki
Jump to: navigation, search
(Created page with "== Syntax == queueremove(<queue_id>,<account_id>); == Description == Removes <account_id> from queue of <queue_id>, returns 1 if <account_id> is not present in the queue, othe...")
 
m (Minor formatting update.)
 
Line 1: Line 1:
 
== Syntax ==
 
== Syntax ==
queueremove(<queue_id>,<account_id>);
+
*'''queueremove'''(<queue_id>,<account_id>);
 
== Description ==
 
== Description ==
 
Removes <account_id> from queue of <queue_id>, returns 1 if <account_id> is not
 
Removes <account_id> from queue of <queue_id>, returns 1 if <account_id> is not
 
present in the queue, otherwise returns 0.
 
present in the queue, otherwise returns 0.
 
== Example ==
 
== Example ==
   if (queueremove(.@id,[[getcharid]](3))==1){;
+
   if ('''queueremove'''(.@id,[[getcharid]](3))==1){;
     mes "You were not in the queue";
+
     [[mes]] "You were not in the queue";
     close;
+
     [[close]];
 
   }
 
   }
 
   //Rest Script code Below
 
   //Rest Script code Below

Latest revision as of 16:38, 6 November 2013

Syntax

  • queueremove(<queue_id>,<account_id>);

Description

Removes <account_id> from queue of <queue_id>, returns 1 if <account_id> is not present in the queue, otherwise returns 0.

Example

 if (queueremove(.@id,getcharid(3))==1){;
   mes "You were not in the queue";
   close;
 }
 //Rest Script code Below
 ......