Bz givePlayerFlag - Revision history

Zehra: redirect, since functions are in official docs

2025-11-26T01:25:14Z

redirect, since functions are in official docs

← Older revision		Revision as of 01:25, 26 November 2025
Line 1:		Line 1:
	~~{{BZFS_API_Doc}}~~		#REDIRECT [[Category:BZFS API Docs]]
	~~{{BZFS_API_Funcs}}~~
	~~==Prototype==~~
	~~BZF_API bool bz_givePlayerFlag ( int playerID, const char* flagType, bool force );~~
	~~==Parameters==~~
	~~{\| border="1" cellpadding="20" cellspacing="0"~~
	~~!name~~
	~~!type~~
	~~!value desription~~
	\|-
	~~\|playerId~~
	~~\|int~~
	~~\|the player that is to get the flag.~~
	\|-
	~~\|flagType~~
	\|const char*
	~~\|The flag code of the flag to give to the player.~~
	\|-
	~~\|force~~
	~~\|bool~~
	~~\|replace the existing flag if it exists~~
	\|}

	~~==Description==~~
	~~This~~ API function will give the specified player the specified flag. If the player has no flag, they will get a flag. If they have a flag and the force parameter is true the new flag code will replace the old flag code. If the force parameter is false, and the player has a flag, no action will be taken.

Zehra: /* Description */ typo

2016-11-25T22:52:52Z

Description: typo

← Older revision		Revision as of 22:52, 25 November 2016
Line 23:		Line 23:

	==Description==		==Description==
	This API function will give the specified player the specified flag. If the player has no flag, they will get a flag. If they have a flag and the force parameter is true the new flag code will replace the old flag code. If the force ~~paramater~~ is false, and the player has a flag, no action will be taken.		This API function will give the specified player the specified flag. If the player has no flag, they will get a flag. If they have a flag and the force parameter is true the new flag code will replace the old flag code. If the force parameter is false, and the player has a flag, no action will be taken.

Sigonasr2: Undo revision 7806 by Sigonasr2 (Talk) - Accidently modified the wrong entry. Meant to modify the bzPlayerRecord.

2011-07-04T05:56:05Z

Undo revision 7806 by Sigonasr2 (Talk) - Accidently modified the wrong entry. Meant to modify the bzPlayerRecord.

← Older revision		Revision as of 05:56, 4 July 2011
Line 15:		Line 15:
	\|flagType		\|flagType
	\|const char*		\|const char*
	\|The flag code of the flag to give to the player~~. The flag code format is a string that looks like:~~		\|The flag code of the flag to give to the player.
	* FLag (+FL)
	Where letters that make up the flag abbreviation is capitalized. So for example, Narrow is Narrow and Wings is WinGs. The content in parenthesis are the actual parenthesis followed by the symbol of the flag. If no flag is being held, this parameter is simply an empty string.
	\|-		\|-
	\|force		\|force

Sigonasr2: Clarify what flagType ACTUALLY returns.

2011-07-04T05:51:51Z

Clarify what flagType ACTUALLY returns.

← Older revision		Revision as of 05:51, 4 July 2011
Line 15:		Line 15:
	\|flagType		\|flagType
	\|const char*		\|const char*
	\|The flag code of the flag to give to the player.		\|The flag code of the flag to give to the player. The flag code format is a string that looks like:
			* FLag (+FL)
			Where letters that make up the flag abbreviation is capitalized. So for example, Narrow is Narrow and Wings is WinGs. The content in parenthesis are the actual parenthesis followed by the symbol of the flag. If no flag is being held, this parameter is simply an empty string.
	\|-		\|-
	\|force		\|force

71.109.219.226: New page: {{BZFS_API_Doc}} {{BZFS_API_Funcs}} ==Prototype== BZF_API bool bz_givePlayerFlag ( int playerID, const char* flagType, bool force ); ==Parameters== {| border="1" cellpadding="20" cellspaci...

2007-08-14T03:35:42Z

New page: {{BZFS_API_Doc}} {{BZFS_API_Funcs}} ==Prototype== BZF_API bool bz_givePlayerFlag ( int playerID, const char* flagType, bool force ); ==Parameters== {| border="1" cellpadding="20" cellspaci...

New page

{{BZFS_API_Doc}}
{{BZFS_API_Funcs}}
==Prototype==
BZF_API bool bz_givePlayerFlag ( int playerID, const char* flagType, bool force );
==Parameters==
{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value desription
|-
|playerId
|int
|the player that is to get the flag.
|-
|flagType
|const char*
|The flag code of the flag to give to the player.
|-
|force
|bool
|replace the existing flag if it exists
|}

==Description==
This API function will give the specified player the specified flag. If the player has no flag, they will get a flag. If they have a flag and the force parameter is true the new flag code will replace the old flag code. If the force paramater is false, and the player has a flag, no action will be taken.