https://drl.chaosforge.org/w/index.php?action=history&feed=atom&title=Modding%3Aplayer_API_%280.9.9.7%29Modding:player API (0.9.9.7) - Revision history2026-05-29T20:56:32ZRevision history for this page on the wikiMediaWiki 1.21.1https://drl.chaosforge.org/w/index.php?title=Modding:player_API_(0.9.9.7)&diff=2566&oldid=prevShark20061: Created page with "''This page is currently under construction.'' You can also use the being API and thing API with the player, since it is also a being. {|class="wikitable" style="border: 2px so..."2013-05-30T21:37:40Z<p>Created page with "''This page is currently under construction.'' You can also use the being API and thing API with the player, since it is also a being. {|class="wikitable" style="border: 2px so..."</p>
<p><b>New page</b></p><div>''This page is currently under construction.''<br />
<br />
You can also use the being API and thing API with the player, since it is also a being.<br />
<br />
{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"<br />
! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|Player Interface<br />
{{Table2Col<br />
|es=background: #333;<br />
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;<br />
|c2=padding:0px 2px;<br />
|{{modarg|void}}|{{moddef|list|set_affect|col||AffectID|id|integer|duration}}<br />
|{{modarg|integer}}|{{moddef|list|get_affect_time|cln||AffectID|id}}<br />
|{{modarg|void}}|{{moddef|list|remove_affect|cln||AffectID|id}}<br />
|{{modarg|boolean}}|{{moddef|list|is_affect|cln||AffectID|id}}<br />
|{{modarg|void}}|{{moddef|list|add_exp|cln||integer|xp}}<br />
|{{modarg|boolean}}|{{moddef|list|has_won|cln}}<br />
|{{modarg|integer}}|{{moddef|list|get_trait|cln||TraitID}}<br />
|{{modarg|string}}|{{moddef|list|get_trait_hist|cln}}<br />
|{{modarg|void}}|{{moddef|list|power_backpack|cln}}<br />
|{{modarg|void}}|{{moddef|list|win|cln}}<br />
|{{modarg|void}}|{{moddef|list|continue_game|cln}}<br />
|{{modarg|void}}|{{moddef|list|choose_trait|cln}}<br />
|{{modarg|void}}|{{moddef|list|level_up|cln}}<br />
|{{modarg|void}}|{{moddef|list|exit|cln||string|[next]}}<br />
|{{modarg|void}}|{{moddef|list|exit|cln||integer|[next]}}<br />
|{{modarg|void}}|{{moddef|list|quick_weapon|cln||ItemID|id}}<br />
|{{modarg|void}}|{{moddef|list|set_inv_size|cln||integer|size}}<br />
|{{modarg|void}}|{{moddef|list|mortem_print|cln||string|line}}<br />
|{{modarg|void}}|{{moddef|list|remove_medals|cln||table|medallist}}<br />
|{{modarg|void}}|{{moddef|list|remove_award|cln||AwardID|award}}<br />
|{{modarg|void}}|{{moddef|list|set_award|cln||AwardID|award|integer|level}}<br />
|{{modarg|boolean}}|{{moddef|list|has_award|cln||AwardID|award|integer|level}}<br />
|{{modarg|integer}}|{{moddef|list|get_award|cln||AwardID|award}}<br />
|{{modarg|void}} |{{moddef|list|remove_medal|cln||MedalID|medal}}<br />
|{{modarg|void}} |{{moddef|list|add_medal|cln||MedalID|medal}}<br />
|{{modarg|boolean}}|{{moddef|list|has_medal|cln||MedalID|medal}}<br />
|{{modarg|void}} |{{moddef|list|remove_badge|cln||BadgeID|badge}}<br />
|{{modarg|void}} |{{moddef|list|add_badge|cln||BadgeID|badge}}<br />
|{{modarg|boolean}}|{{moddef|list|has_badge|cln||BadgeID|badge}}<br />
|{{modarg|void}} |{{moddef|list|remove_assembly|cln||ModArrayID|assembly}}<br />
|{{modarg|void}} |{{moddef|list|add_assembly|cln||ModArrayID|assembly}}<br />
|{{modarg|boolean}}|{{moddef|list|has_assembly|cln||ModArrayID|assembly}}<br />
|{{modarg|void}} |{{moddef|list|remove_found_item|cln||ItemID|item}}<br />
|{{modarg|void}} |{{moddef|list|add_found_item|cln||ItemID|item}}<br />
|{{modarg|boolean}}|{{moddef|list|has_found_item|cln||ItemID|item}}<br />
|{{modarg|void}} |{{moddef|list|add_history|cln||string|line}}<br />
|}}<br />
|}<br />
----<br />
;{{moddef|desc|set_affect|col||AffectID|id|integer|duration}}<br />
Adds the indicated affect to the player.<br />
:''id'': The ID of the affect to add.<br />
:''duration'': The number of actions to add the affect for. If the affect is already active, the duration is extended by this amount.<br />
----<br />
;{{moddef|desc|get_affect_time|cln|integer|AffectID|id}}<br />
Gets the remaining duration of the indicated affect.<br />
:''id'': The ID of the affect to get the duration for.<br />
:'''Returns''': The remaining duration of the affect.<br />
----<br />
;{{moddef|desc|remove_affect|cln||AffectID|id}}<br />
Removes the indicated affect from the player.<br />
:''id'': The ID of the affect to remove.<br />
----<br />
;{{moddef|desc|is_affect|cln|boolean|AffectID|id}}<br />
Checks to see if the given affect is active on the player.<br />
:''id'': The ID of the affect to check for.<br />
:'''Returns''': ''True'' if the affect is currently active on the player, ''False'' if not.<br />
----<br />
;{{moddef|desc|add_exp|cln||integer|xp}}<br />
Gives the player extra experience points.<br />
:''xp'': The amount of experience to add.<br />
----<br />
;{{moddef|desc|has_won|cln|boolean}}<br />
Indicates whether the player has won or not.<br />
:'''Returns''': ''True'' if the player has won the game, ''False'' if not.<br />
----<br />
;{{moddef|desc|get_trait|cln|integer|TraitID}}<br />
integer player:get_trait ( integer trait )<br />
Gets the current level of a given trait.<br />
:''trait'': The trait to get the level for.<br />
:'''Returns''': The level of the trait.<br />
----<br />
;{{moddef|desc|get_trait_hist|cln|string}}<br />
Gets the history string for the player's traits ("Iro->Iro->HR").<br />
:'''Returns''': The history string.<br />
----<br />
;{{moddef|desc|power_backpack|cln}}<br />
Gives the player the BF_BACKPACK flag and re-packs the ammo items in the inventory.<br />
----<br />
;{{moddef|desc|win|cln}}<br />
Makes the player win the game and ends the game at the end of the turn.<br />
----<br />
;{{moddef|desc|continue_game|cln}}<br />
Stops the game from ending at the end of the turn.<br />
----<br />
;{{moddef|desc|choose_trait|cln}}<br />
Opens the trait menu and allows the player to pick a new trait.<br />
----<br />
;{{moddef|desc|level_up|cln}}<br />
Increments the player's level count, calls the level up hooks, opens the trait menu, and prints the appropriate messages.<br />
----<br />
;{{moddef|desc|exit|cln||string|[next]}}<br />
;{{moddef|desc|exit|cln||integer|[next]}}<br />
Leaves the current level and goes to the specified level.<br />
:''next'': ''Optional.'' The string ID of the special level to go to, or the number of the level in the episode to exit to. If omitted, the default is to go to the next numbered level in the episode.<br />
----<br />
;{{moddef|desc|quick_weapon|cln||ItemID|id}}<br />
Quick-swaps the equipped weapon with indicated weapon ID, if it is in the player's inventory.<br />
:''id'': The id of the weapon to swap to.<br />
----<br />
;{{moddef|desc|set_inv_size|cln||integer|size}}<br />
Sets the number of usable slots in the player's inventory.<br />
:''size'': A number from 1 to MAX_INV_SIZE to set the number of available slots to.<br />
----<br />
;{{moddef|desc|mortem_print|cln||string|line}}<br />
Writes a line of the mortem. Can only be used while printing the mortem.<br />
:''line'': The text to write.<br />
----<br />
;{{moddef|desc|remove_medals|cln||table|medallist}}<br />
Removes specified medals from the player's earned medals list.<br />
:''medallist'': The list of medals to remove.<br />
----<br />
;{{moddef|desc|remove_award|cln||AwardID|award}}<br />
Removes a custom award from the player's data.<br />
:''award'': The award to remove.<br />
----<br />
;{{moddef|desc|set_award|cln||AwardID|award|integer|level}}<br />
Grants the indicated award to the player.<br />
:''award'': The award to give.<br />
:''level'': The quality level of the award to give.<br />
----<br />
;{{moddef|desc|has_award|cln|boolean|AwardID|award|integer|level}}<br />
Indicates if the player has earned the specified award.<br />
:''award'': The award to check for.<br />
:''level'': The minimum quality level of the award to check for.<br />
:'''Returns''': ''True'' if the player has at least the given level of the given award, ''False'' otherwise.<br />
----<br />
;{{moddef|desc|get_award|cln|integer|AwardID|award}}<br />
Gets the quality level of a specified award.<br />
:''award'': The award to look for.<br />
:'''Returns''': The current level of the award earned. 0 is returned if the award has not been earned at all.<br />
----<br />
;{{moddef|desc|remove_medal|cln||MedalID|medal}}<br />
Removes a medal from the player's earned medals.<br />
:''medal'': The medal to remove.<br />
----<br />
;{{moddef|desc|add_medal|cln||MedalID|medal}}<br />
Grants a medal to the player.<br />
:''medal'': The medal to give.<br />
----<br />
;{{moddef|desc|has_medal|cln|boolean|MedalID|medal}}<br />
Checks if the player has a specified medal.<br />
:''medal'': The medal to check for.<br />
:'''Returns''': ''True'' if the player has earned the medal, ''False'' if they have not.<br />
----<br />
;{{moddef|desc|remove_badge|cln||BadgeID|badge}}<br />
Removes a badge from the player's earned badges.<br />
:''badge'': The badge to remove.<br />
----<br />
;{{moddef|desc|add_badge|cln||BadgeID|badge}}<br />
Grants a badge to the player.<br />
:''badge'': The badge to add.<br />
----<br />
;{{moddef|desc|has_badge|cln|boolean|BadgeID|badge}}<br />
Checks to see if the player has the specified badge.<br />
:''badge'': The badge to check for.<br />
:'''Returns''': ''True'' if the player has earned the indicated badge, ''False'' if not.<br />
----<br />
;{{moddef|desc|remove_assembly|cln||ModArrayID|assembly}}<br />
Removes an assembly from the list of created assemblies.<br />
:''assembly'': The assembly to remove.<br />
----<br />
;{{moddef|desc|add_assembly|cln||ModArrayID|assembly}}<br />
Adds an assembly to the list of created assemblies.<br />
:''assembly'': The assembly to add.<br />
----<br />
;{{moddef|desc|has_assembly|cln|boolean|ModArrayID|assembly}}<br />
Checks to see if the player has the specified assembly in the list of created assemblies.<br />
:''assembly'': The assembly to check for.<br />
:'''Returns''': ''True'' if the assembly is in the list, ''False'' if it is not.<br />
----<br />
;{{moddef|desc|remove_found_item|cln||ItemID|item}}<br />
Removes the indicated item from the list of found items.<br />
:''item'': The item to remove.<br />
----<br />
;{{moddef|desc|add_found_item|cln||ItemID|item}}<br />
Adds the indicated item to the list of found items.<br />
:''item'': The item to add.<br />
----<br />
;{{moddef|desc|has_found_item|cln|boolean|ItemID|item}}<br />
Checks to see if the player has the indicated item.<br />
:''item'': The item to check for.<br />
:'''Returns''': ''True'' if the player has found the item, ''False'' if they have not.<br />
----<br />
;{{moddef|desc|add_history|cln||string|line}}<br />
Adds a line to the history section of the mortem. Can be called anywhere prior to the end of printing the mortem.<br />
:''line'': The line of text to add. Use "@1" in the string to insert the current depth.<br />
----</div>Shark20061