GetBanUsername: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Server function}} This function will return the username of the specified ban element. ==Syntax== <syntaxhighlight lang="lua"> string getBanUsername ( ban theBan ) </syntaxhighlight> ===Required...)
 
mNo edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server function}}
This function will return the username of the specified [[ban]] element.
This function will return the username of the specified [[ban]] pointer.


==Syntax==  
==Syntax==  
Line 9: Line 9:


===Required Arguments===  
===Required Arguments===  
*'''theBan:''' The [[ban]] element which username you want to return.
*'''theBan:''' The [[ban]] in which you wish to retrieve the username of.


===Returns===
===Returns===
Returns a ''string'' of the username if everything was successfull, ''false'' if invalid arguments are specified if there was no username specified for the [[ban]] element.
Returns a ''string'' of the username if everything was successful, ''false'' if invalid arguments are specified if there was no username specified for the [[ban]].


==Example==
==Example==

Revision as of 17:39, 23 January 2009

This function will return the username of the specified ban pointer.

Syntax

string getBanUsername ( ban theBan )

Required Arguments

  • theBan: The ban in which you wish to retrieve the username of.

Returns

Returns a string of the username if everything was successful, false if invalid arguments are specified if there was no username specified for the ban.

Example

--TODO

See Also