Sigonasr2: Create API Function Page. Include Example.

2011-10-19T08:30:05Z

Create API Function Page. Include Example.

New page

{{apicall
| name = bz_HostBanUser
| returns = Whether or not the ban was executed successfully.
| returntype = bool
| description = Sets up a new Host ban Rule in the ban list.
| param1 = bannedByIndex
| param1type = int
| param1desc = The player ID that is banning the IP Address. '''NOTE:''' This has to be a player that is currently on the server, so at least one player must be present for a ban to be created.
| param2 = hostmask
| param2type = const char*
| param2desc = The Hosting address of the player to be banned. Host bans use wildcard (*) character also, such as *.myhost.biz
| param3 = duration
| param3type = int
| param3desc = The amount of time in minutes to ban the host.
| param4 = reason
| param4type = const char*
| param4desc = The reason that is displayed to the banned user upon failure to join.
}}

===Example===
bz_HostBanUser(0,"*.myhost.biz",3600,"This host abused the server.")

Bz HostBanUser - Revision history

Sigonasr2: Create API Function Page. Include Example.