Difference between revisions of "Bz getFlagName"

From BZFlagWiki
Jump to: navigation, search
(Notes)
m (Rename function to bz_getName() for now.)
Line 2: Line 2:
 
{{BZFS_API_Funcs}}
 
{{BZFS_API_Funcs}}
 
==Prototype==
 
==Prototype==
BZF_API const [[bz_ApiString]] bz_getFlagName( int flag );
+
BZF_API const [[bz_ApiString]] bz_getName( int flag );
 
==Parameters==
 
==Parameters==
 
{| border="1" cellpadding="20" cellspacing="0"
 
{| border="1" cellpadding="20" cellspacing="0"
Line 16: Line 16:
 
==Description==
 
==Description==
 
This API function returns the flag code for the specified flag.
 
This API function returns the flag code for the specified flag.
 
==Notes==
 
This function replaced [[bz_getName]] as of v2.0.15
 

Revision as of 13:55, 18 November 2011

BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.
BZFS API Function. This page documents a BZFS_API Function, that is provided by the BZFS game server for plug-ins to call.

Prototype

BZF_API const bz_ApiString bz_getName( int flag );

Parameters

name type value description
flag int the flag to return

Description

This API function returns the flag code for the specified flag.