A GivePlayerMedal: Difference between revisions

From Zandronum Wiki
(Created a page for the A_GivePlayerMedal DECORATE function.)
Tag: Source edit
 
m (Fix display title)
Tag: Source edit
Line 1: Line 1:
{{ACSWarning}}
{{DISPLAYTITLE:{{PAGENAMEE}}}}{{ACSWarning}}
{{DevfeatureWarning|version=3.2|type=a [[DECORATE]] function}}
{{DevfeatureWarning|version=3.2|type=a [[DECORATE]] function}}
bool '''A_GivePlayerMedal''' (str ''medal'', bool ''silent'' [, pointer ''receiver'']) {{Devfeature|3.2|alpha}}
bool '''A_GivePlayerMedal''' (str ''medal'', bool ''silent'' [, pointer ''receiver'']) {{Devfeature|3.2|alpha}}

Revision as of 14:41, 27 May 2024

This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports.
This article documents a DECORATE function which is only available in development builds of Zandronum 3.2 and newer.

bool A_GivePlayerMedal (str medal, bool silent [, pointer receiver]) (development version 3.2-alpha and above only)

Usage

A DECORATE version of GivePlayerMedal, used to award a player with a medal.

Parameters

  • medal: The name of the medal to be awarded.
  • silent: If true, then when the player receives the medal, it won't appear on the screen or above their head, and no sounds will be played.
  • receiver: The actor that receives the medal. This must point to a valid player. By default, this is AAPTR_DEFAULT, which corresponds to the caller of the function.

Return value

Returns true on success or false on failure.

Examples

This article lists no examples, please add one.