ResetCustomDataToDefault: Difference between revisions

From Zandronum Wiki
m (remove accidental copypaste parameter)
Tag: Source edit
m (Using -1 for the "player" parameter resets the data for all players.)
Tag: Source edit
Line 10: Line 10:
===Parameters===
===Parameters===
* ''data'': The data field as defined in [[MAPINFO#GameInfo definition|the GameInfo definition]].
* ''data'': The data field as defined in [[MAPINFO#GameInfo definition|the GameInfo definition]].
* ''player'': The player number to reset the data for.
* ''player'': The player number to reset the data for. Use -1 to reset all players instead.


===Return value===
===Return value===

Revision as of 02:17, 14 June 2023

This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports.
This article documents an ACS function which is only available in development builds of Zandronum 3.2 and newer.
This article or section is a stub. You can help the Zandronum wiki by adding to it.

int ResetCustomDataToDefault (str data, int player) (development version 3.2-alpha and above only)

Usage

Resets the value of a player's data field for the scoreboard back to its default value.

Parameters

  • data: The data field as defined in the GameInfo definition.
  • player: The player number to reset the data for. Use -1 to reset all players instead.

Return value

Returns 1 if the field and player exist, 0 otherwise.

Examples

This article lists no examples, please add one.