CheckFlag

From Eternity Wiki
Revision as of 02:03, 22 September 2022 by Printz (talk | contribs) (Created page with "{{ACSFunction|description=Checks if a tagged thing has the given EDF flag. |usage=''bool'' '''CheckFlag'''(''int tid'', ''str flag'') |parameters= *''tid'...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Description[edit]

This is an ACS built-in function.

Checks if a tagged thing has the given EDF flag.

Usage[edit]

bool CheckFlag(int tid, str flag)

Parameters[edit]

  • tid: TID of map object to check
  • flag: name of flag to check

Return value[edit]

TRUE if the tagged thing has that flag, FALSE otherwise

Examples[edit]

int isShootable = CheckFlag(2, "SHOOTABLE");
int isInvisible = CheckFlag(4, "DONTDRAW");
int activatorHasPartialInvisibility = CheckFlag(0, "SHADOW");

Notes[edit]

This function can only check for one flag on one thing at a time. Checking multiple flags isn't possible. If multiple things have the TID, only the first one found will be checked.

This function's identification in zspecial.acs is: -75.

See also[edit]