OnBan: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: Category:Private __NOTOC__<!-- Remove all comments from this page when you're done!--> {{Server event}} <!-- Change this to Client event if it's clientside --> <!-- Describe in plai...)
 
No edit summary
Line 1: Line 1:
 
__NOTOC__
 
{{Server event}}
 
This event is triggered when an IP address or serial is banned from the server.
[[Category:Private]]
__NOTOC__<!-- Remove all comments from this page when you're done!-->
{{Server event}} <!-- Change this to Client event if it's clientside -->
<!-- Describe in plain english when does this event trigger. Don't go into details, just give an overview -->
This event is triggered when...


==Parameters==
==Parameters==
<!-- NOTE: don't use datatype names for parameter names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd. Don't use Lua library functions / keywords either. -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string parameter1, int parameter2
string theIPOrSerial
</syntaxhighlight>  
</syntaxhighlight>  


*'''parameter1''': A string representing...
*'''theIPOrSerial''': The IP address or serial that was banned from the server.
*'''parameter2''': An integer representing...


<!-- Add the event's source in the section below -->
<!-- Add the event's source in the section below -->
==Source==
==Source==
The [[event system#Event source|source]] of this event is the [[element]] that...
The [[event system#Event source|source]] of this event is the [[element]] that was responsible for the banning. If no responsible was specified, the source is the global root element.


<!-- Only include this section below if cancelling the event has any effect. If you don't know if it does, ask a dev! -->
<!-- Only include this section below if cancelling the event has any effect. If you don't know if it does, ask a dev! -->
==Cancel effect==
==Cancel effect==
If this event is [[Event system#Canceling|canceled]], ...
If this event is [[Event system#Canceling|canceled]], the requested ban is not performed.


==Example==  
==Example==  
Line 38: Line 31:
==See Also==
==See Also==
{{Event_functions}}
{{Event_functions}}
<!-- leave this until syntax is available. Cannot document the function or event without syntax.-->
[[Category:Need_Syntax]]
<!-- leave this unless you complete the event -->
[[Category:Incomplete Event]]
<!-- leave this unless you provide a good example -->
[[Category:Needs Example]]
[[Category:Needs Example]]

Revision as of 06:15, 30 December 2007

This event is triggered when an IP address or serial is banned from the server.

Parameters

string theIPOrSerial
  • theIPOrSerial: The IP address or serial that was banned from the server.

Source

The source of this event is the element that was responsible for the banning. If no responsible was specified, the source is the global root element.

Cancel effect

If this event is canceled, the requested ban is not performed.

Example

This example does...

--This line does...
blah()
--This line does this...
mooo

See Also