Civ5 API FAQ - Revision history

DonQuich at 12:10, 25 September 2012

2012-09-25T12:10:31Z

← Older revision		Revision as of 12:10, 25 September 2012
Line 2:		Line 2:


	== Firaxis Hungarian notation ==		= Firaxis Hungarian notation =
	=== What is it? ===		=== What is it? ===
	Firaxis used a naming convention categorized as [http://en.wikipedia.org/wiki/Hungarian_notation Hungarian Notation]. The prefixes provide informations regarding the type.		Firaxis used a naming convention categorized as [http://en.wikipedia.org/wiki/Hungarian_notation Hungarian Notation]. The prefixes provide informations regarding the type.

DonQuich at 17:24, 21 September 2012

2012-09-21T17:24:58Z

← Older revision		Revision as of 17:24, 21 September 2012
Line 22:		Line 22:
	* Pro: it's widely used in the community and your code will harmonize with the one from Firaxis.		* Pro: it's widely used in the community and your code will harmonize with the one from Firaxis.
	* Pro: you always now the type of a variable by looking at its name, which is useful since ModBuddy does not inform us about the type.		* Pro: you always now the type of a variable by looking at its name, which is useful since ModBuddy does not inform us about the type.
	* Con: it's not really necessary, most of the time a consistent naming is enough to know the type of a variable: for example playerID for a {{Type5\|PlayerID}} and player for a {{Type5\|Player}}.		* Con: it adds some clutter and it's not really necessary because most of the time a consistent naming is enough to know the type of a variable: for example playerID for a {{Type5\|PlayerID}} and player for a {{Type5\|Player}}.


	[[Category:Civ5 API]]		[[Category:Civ5 API]]

DonQuich at 17:24, 21 September 2012

2012-09-21T17:24:24Z

← Older revision		Revision as of 17:24, 21 September 2012
Line 20:		Line 20:

	=== Should you use the same notation? ===		=== Should you use the same notation? ===
	~~Well, it's up to you, there are arguments in favor of it and some others against it.~~
	* Pro: it's widely used in the community and your code will harmonize with the one from Firaxis.		* Pro: it's widely used in the community and your code will harmonize with the one from Firaxis.
	* Pro: you always now the type of a variable by looking at its name, which is useful since ModBuddy does not inform us about the type.		* Pro: you always now the type of a variable by looking at its name, which is useful since ModBuddy does not inform us about the type.

DonQuich at 17:24, 21 September 2012

2012-09-21T17:24:03Z

← Older revision		Revision as of 17:24, 21 September 2012
Line 3:		Line 3:

	== Firaxis Hungarian notation ==		== Firaxis Hungarian notation ==
			=== What is it? ===
	Firaxis used a naming convention categorized as [http://en.wikipedia.org/wiki/Hungarian_notation Hungarian Notation]. The prefixes provide informations regarding the type.		Firaxis used a naming convention categorized as [http://en.wikipedia.org/wiki/Hungarian_notation Hungarian Notation]. The prefixes provide informations regarding the type.
	* '''s''', '''sz''' and '''str''' mean a string.		* '''s''', '''sz''' and '''str''' mean a string.

DonQuich at 17:23, 21 September 2012

2012-09-21T17:23:32Z

← Older revision		Revision as of 17:23, 21 September 2012
Line 18:		Line 18:


	=== Should you use the same notation ===		=== Should you use the same notation? ===
	Well, it's up to you, there are arguments in favor of it and some others against it.		Well, it's up to you, there are arguments in favor of it and some others against it.
	* Pro: it's widely used in the community and your code will harmonize with the one from Firaxis.		* Pro: it's widely used in the community and your code will harmonize with the one from Firaxis.

DonQuich at 17:23, 21 September 2012

2012-09-21T17:23:20Z

← Older revision		Revision as of 17:23, 21 September 2012
Line 18:		Line 18:


	Should you use the same notation? Well, it's up to you, there are arguments in favor of it and some others against it.		=== Should you use the same notation ===
			Well, it's up to you, there are arguments in favor of it and some others against it.
	* Pro: it's widely used in the community and your code will harmonize with the one from Firaxis.		* Pro: it's widely used in the community and your code will harmonize with the one from Firaxis.
	* Pro: you always now the type of a variable by looking at its name, which is useful since ModBuddy does not inform us about the type.		* Pro: you always now the type of a variable by looking at its name, which is useful since ModBuddy does not inform us about the type.

DonQuich at 11:14, 21 September 2012

2012-09-21T11:14:31Z

← Older revision		Revision as of 11:14, 21 September 2012
Line 1:		Line 1:
	This page is a part of the [[Lua and UI Reference (Civ5)\|Lua and UI Reference]]		''This page is a part of the [[Lua and UI Reference (Civ5)\|Lua and UI Reference]].''


	== Firaxis Hungarian notation ==		== Firaxis Hungarian notation ==

DonQuich: Created page with "This page is a part of the Lua and UI Reference == Firaxis Hungarian notation == Firaxis used a naming convention categorized as [http://en.wikip..."

2012-09-21T11:12:33Z

Created page with "This page is a part of the Lua and UI Reference == Firaxis Hungarian notation == Firaxis used a naming convention categorized as [http://en.wikip..."

New page

This page is a part of the [[Lua and UI Reference (Civ5)|Lua and UI Reference]]

== Firaxis Hungarian notation ==
Firaxis used a naming convention categorized as [http://en.wikipedia.org/wiki/Hungarian_notation Hungarian Notation]. The prefixes provide informations regarding the type.
* '''s''', '''sz''' and '''str''' mean a string.
::Example: '''sName''' expects something like "Genghis Khan".
* '''b''' means boolean.
::Example: '''bHide''' expects true or false.
* '''f''' means floating-point, a number.
::Example: '''fScale''' expects a scale factor, may be 0.5, 1.0, 2.0, etc.
* '''i''' means integer, a number. Sometimes it may be one of the identifiers listed on the main page.
::Example: '''iPlayer''' expects a {{Type5|PlayerID}} while '''iWidth''' expects a width in pixels (50, 200, etc).
* '''e''' means an identifier (integer) taken from a Lua enumeration.
::Example: '''eBuilding''' expects a {{Type5|BuildingType}}. You could assign it with 10 or <code>GameInfoTypes.BUILDING_SEAPORT </code>, both are equivalent.
* '''p''' means an API object (p means pointer but pointer is a C term with no relevance in Lua).
::Example: '''pPlayer''' expects a {{Type5|Player}} object.

Should you use the same notation? Well, it's up to you, there are arguments in favor of it and some others against it.
* Pro: it's widely used in the community and your code will harmonize with the one from Firaxis.
* Pro: you always now the type of a variable by looking at its name, which is useful since ModBuddy does not inform us about the type.
* Con: it's not really necessary, most of the time a consistent naming is enough to know the type of a variable: for example playerID for a {{Type5|PlayerID}} and player for a {{Type5|Player}}.

[[Category:Civ5 API]]