Game Hunter: removed 0994 warning

2011-09-05T01:52:44Z

removed 0994 warning

Tehtmi: Created page

2011-08-16T06:00:23Z

Created page

New page

{{994 modding}}

The player. AKA you. Runs around half-cocked, blows shit up. The player is a [[Modding:Being|Being]] and a [[Modding:Thing|Thing]], but there are also a few properties and functions that are specific to the player. The player is created from the "soldier" being prototype. In lua, there is a global variable called player that holds a reference to the player.

== Properties ==

The player also has all [[Modding:Being#Properties|being properties]] and [[Modding:Thing#Properties|thing properties]].
{|style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
|colspan=3 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Player'''
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''Boolean'''
|style="vertical-align:top; padding-right: 2ex;"|running
|This is true when the player is [[Tactics|running]]. Setting this to false will make the player tired.
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''Boolean'''
|style="vertical-align:top; padding-right: 2ex;"|tired
|This true when the player is [[Tactics|tired]]. Setting this to false will restore the player to cautious.
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''Word'''
|style="vertical-align:top; padding-right: 2ex;"|runningtime
|This is the number of actions the player has until his running tactic expires.
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''LongInt'''
|style="vertical-align:top; padding-right: 2ex;"|exp
|This is the player's current [[experience]] total. Increasing this value directly won't cause the player to gain a level.
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''Byte'''
|style="vertical-align:top; padding-right: 2ex;"|explevel
|This is the player's level. Changing it won't remove traits or trigger level ups. Lowering it can allow the player to achieve lower levels again.
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Klass|Klass ID]]
|style="vertical-align:top; padding-right: 2ex;"|klass
|This is the numeric id of the player's class.
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''Word'''
|style="vertical-align:top; padding-right: 2ex;"|nuketime
|This is the number of 0.1s intervals remaining until a [[Thermonuclear bomb|nuclear explosion]] occurs. Setting this to 0 will halt the current countdown.
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''Real'''
|style="vertical-align:top; padding-right: 2ex;"|expfactor
|All of the player's experience gains are multiplied by this factor. This is normally set based on the difficulty level.
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''string'''
|style="vertical-align:top; padding-right: 2ex;"|killedby
|This is the string that indicates how the player was killed (but not where). This is automatically set by the engine at the beginning of mortem output. This property is read-only.
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Rank|Skill Rank ID]]
|style="vertical-align:top; padding-right: 2ex;"|skillrank
|This is the numeric id of the player's current skill rank. This property is read-only.
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Rank|Exp Rank ID]]
|style="vertical-align:top; padding-right: 2ex;"|exprank
|This is the numeric id of the player's current exp rank. This property is read-only.
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''LongInt'''
|style="vertical-align:top; padding-right: 2ex;"|score
|This is the player's current score. This property is read-only.
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''Byte'''
|style="vertical-align:top; padding-right: 2ex;"|depth
|This is the level of the dungeon that the player is currently on. (Level generation should usually ignore this, instead using the [[Modding:Level]] values.) This property is read-only.
|}
== API ==

The player can also use the [[Modding:Being#API|being API]] and [[Modding:Thing#API|thing API]].
{|style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
|colspan=2 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Player Interface'''
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_set_affect|set_affect]]([[Modding:Affect|Affect ID]] affect, '''integer''' duration)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''boolean'''
|[[Modding:Player|Player]]:[[#player_is_affect|is_affect]]([[Modding:Affect|Affect ID]] affect)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_add_exp|add_exp]]('''integer''' exp)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''boolean'''
|[[Modding:Player|Player]]:[[#player_has_won|has_won]]()
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''integer'''
|[[Modding:Player|Player]]:[[#player_get_trait|get_trait]]([[Modding:Trait|Trait ID]] trait)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''string'''
|[[Modding:Player|Player]]:[[#player_get_trait_hist|get_trait_hist]]()
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_power_backpack|power_backpack]]()
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_win|win]]()
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_choose_trait|choose_trait]]()
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_level_up|level_up]]()
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_exit|exit]]('''integer''' level)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_exit|exit]]([[Modding:Level|Level ID]] level)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''boolean'''
|[[Modding:Player|Player]]:[[#player_record_badge|record_badge]]([[Modding:Badge|Badge ID]] id)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_quick_weapon|quick_weapon]]([[Modding:Item|Item ID]] id)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_set_inv_size|set_inv_size]]('''integer''' size)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''boolean'''
|[[Modding:Player|Player]]:[[#player_found_item|found_item]]([[Modding:Item|Item ID]] id)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_assembled_item|assembled_item]]([[Modding:ModArray|ModArray ID]] id)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_mortem_print|mortem_print]]('''string''' mortemtext)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_add_medal|add_medal]]([[Modding:Medal|Medal ID]] medal)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_remove_medal|remove_medal]]([[Modding:Medal|Medal ID]] medal)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_remove_medals|remove_medals]]([[Modding:Medal|Medal ID]] '''list''' medallist)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''boolean'''
|[[Modding:Player|Player]]:[[#player_has_medal|has_medal]]([[Modding:Medal|Medal ID]] medal)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_add_badge|add_badge]]([[Modding:Badge|Badge ID]] badge)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_remove_badge|remove_badge]]([[Modding:Badge|Badge ID]] badge)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''boolean'''
|[[Modding:Player|Player]]:[[#player_has_badge|has_badge]]([[Modding:Badge|Badge ID]] badge)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Player|Player]]:[[#player_add_history|add_history]]('''string''' historytext)
|}

{{Anchor|player_set_affect}}
;[[Modding:Player|Player]]:set_affect([[Modding:Affect|Affect ID]] affect, '''integer''' duration)
:Adds ''duration'' actions to the appropriate affect timer. This will properly trigger affect activation hooks.
----
{{Anchor|player_is_affect}}
;[[Modding:Player|Player]]:is_affect([[Modding:Affect|Affect ID]] affect) → '''boolean'''
:Determines if the given affect is currently active on the player.
----
{{Anchor|player_add_exp}}
;[[Modding:Player|Player]]:add_exp('''integer''' exp)
:Adds the given amount of experience to the player. This can trigger level ups. (To avoid level ups, player.exp and player.explevel can be modified directly.)
----
{{Anchor|player_has_won}}
;[[Modding:Player|Player]]:has_won() → '''boolean'''
:Determines if the player has won the game. Typically, this will only be true during mortem generation (if the player has indeed won).
----
{{Anchor|player_get_trait}}
;[[Modding:Player|Player]]:get_trait([[Modding:Trait|Trait ID]] trait) → '''integer'''
:Counts the number of levels the player has in the given trait.
----
{{Anchor|player_get_trait_hist}}
;[[Modding:Player|Player]]:get_trait_hist() → '''string'''
:Returns a string describing the player's previous trait selections as seen in the mortem.
----
{{Anchor|player_power_backpack}}
;[[Modding:Player|Player]]:power_backpack()
:Adds the BF_BACKPACK flag to the player and then resorts the ammo in the player's inventory.
----
{{Anchor|player_win}}
;[[Modding:Player|Player]]:win()
:Ends the game; the player is considered to have won the game for the purposes of player:has_won().
----
{{Anchor|player_choose_trait}}
;[[Modding:Player|Player]]:choose_trait()
:Allows the player to pick a new trait (as if a level up had occured).
----
{{Anchor|player_level_up}}
;[[Modding:Player|Player]]:level_up()
:Causes the player to level up. Experience is not affected. This is similar to player:choose_trait(), but level up events are triggered, and the player's explevel increases.
----
{{Anchor|player_exit}}
;[[Modding:Player|Player]]:exit('''integer''' level)
:Causes the player to enter the dungeon level given by ''level''. With no argument, the player advances to the next level.
----
{{Anchor|player_exit}}
;[[Modding:Player|Player]]:exit([[Modding:Level|Level ID]] level)
:Causes the player to enter the given special level.
----
{{Anchor|player_record_badge}}
;[[Modding:Player|Player]]:record_badge([[Modding:Badge|Badge ID]] id) → '''boolean'''
:Adds the given badge to the player's profile. (Modules have either separate profiles or no profiles.) Returns false if there is no player profile, or if the player already had the badge.
----
{{Anchor|player_quick_weapon}}
;[[Modding:Player|Player]]:quick_weapon([[Modding:Item|Item ID]] id)
:Causes the player to prepare a weapon of the given type as though pressing a quickkey. This is affected by BF_JUGGLER. ''id'' must be a string id.
----
{{Anchor|player_set_inv_size}}
;[[Modding:Player|Player]]:set_inv_size('''integer''' size)
:Sets the player's inventory size. The new size can't be bigger than [[Modding:Constants#Maximums|MAX_INV_SIZE]], nor can it be 0. This doesn't do anything with items in the inventory that are already beyond the limit.
----
{{Anchor|player_found_item}}
;[[Modding:Player|Player]]:found_item([[Modding:Item|Item ID]] id) → '''boolean'''
:Determines if the player has previously picked up an item with the given id.
----
{{Anchor|player_assembled_item}}
;[[Modding:Player|Player]]:assembled_item([[Modding:ModArray|ModArray ID]] id)
:Adds the given assembly to the player's list of assemblies that have been created in the current game. If there is a profile, the assembly will be added there as well.
----
{{Anchor|player_mortem_print}}
;[[Modding:Player|Player]]:mortem_print('''string''' mortemtext)
:This can only be called while the mortem is being generated. It adds the given line of text to the player's mortem.
----
{{Anchor|player_add_medal}}
;[[Modding:Player|Player]]:add_medal([[Modding:Medal|Medal ID]] medal)
:Adds the given medal to the list of medals the player has achieved in the current game.
----
{{Anchor|player_remove_medal}}
;[[Modding:Player|Player]]:remove_medal([[Modding:Medal|Medal ID]] medal)
:Removes the given medal from the list of medals the player has achieved in the current game.
----
{{Anchor|player_remove_medals}}
;[[Modding:Player|Player]]:remove_medals([[Modding:Medal|Medal ID]] '''list''' medallist)
:This removes all the medals in ''medallist'' from the medals that the player has achieved in the current game. Calling this with nil equates to calling it with the empty list.
----
{{Anchor|player_has_medal}}
;[[Modding:Player|Player]]:has_medal([[Modding:Medal|Medal ID]] medal) → '''boolean'''
:Determines if the player has achieved the given medal in the current game.
----
{{Anchor|player_add_badge}}
;[[Modding:Player|Player]]:add_badge([[Modding:Badge|Badge ID]] badge)
:Adds the given badge to the list of badges the player has achieved in the current game.
----
{{Anchor|player_remove_badge}}
;[[Modding:Player|Player]]:remove_badge([[Modding:Badge|Badge ID]] badge)
:Removes the given badge from the list of badges the player has achieved in the current game.
----
{{Anchor|player_has_badge}}
;[[Modding:Player|Player]]:has_badge([[Modding:Badge|Badge ID]] badge) → '''boolean'''
:Determines if the player has achieved the given badge in the current game.
----
{{Anchor|player_add_history}}
;[[Modding:Player|Player]]:add_history('''string''' historytext)
:Adds the given line to the history section of the mortem. Unlike print_mortem, this can be done while the game is still ongoing. (The default mortem handler prints the history section, but a custom handler might not.)

← Older revision		Revision as of 02:07, 22 April 2013
Line 1:		Line 1:
		+	Within the context of modding the 'player' can refer to:
		+
		+	* The [[Modding:player_API (0.9.9.7)\|player API]], a set of functions which can be used to manipulate player specific content during gameplay.
		+	* The [[Modding:player_object (0.9.9.7)\|player object]], a singleton that inherits from [[Modding:being\|being]] and which represents you, the player, in-game as a standard, alterable object.
		+
		+
		+	These pages will be split our from the 0996 data soon.
		+	Original 0996 below
		+	------
		+
	The player. AKA you. Runs around half-cocked, blows shit up. The player is a [[Modding:Being\|Being]] and a [[Modding:Thing\|Thing]], but there are also a few properties and functions that are specific to the player. The player is created from the "soldier" being prototype. In lua, there is a global variable called player that holds a reference to the player.		The player. AKA you. Runs around half-cocked, blows shit up. The player is a [[Modding:Being\|Being]] and a [[Modding:Thing\|Thing]], but there are also a few properties and functions that are specific to the player. The player is created from the "soldier" being prototype. In lua, there is a global variable called player that holds a reference to the player.

← Older revision		Revision as of 01:52, 5 September 2011
Line 1:		Line 1:
−	~~{{994 modding}}~~
−
	The player. AKA you. Runs around half-cocked, blows shit up. The player is a [[Modding:Being\|Being]] and a [[Modding:Thing\|Thing]], but there are also a few properties and functions that are specific to the player. The player is created from the "soldier" being prototype. In lua, there is a global variable called player that holds a reference to the player.		The player. AKA you. Runs around half-cocked, blows shit up. The player is a [[Modding:Being\|Being]] and a [[Modding:Thing\|Thing]], but there are also a few properties and functions that are specific to the player. The player is created from the "soldier" being prototype. In lua, there is a global variable called player that holds a reference to the player.

Modding:player (0.9.9.7) - Revision history

Yaflhdztioxo at 02:07, 22 April 2013

Yaflhdztioxo: moved Modding:Player to Modding:player (0.9.9.7)

Game Hunter: incidentally, the tag underlines things

Game Hunter: removed 0994 warning

Tehtmi: Created page