User Tools

Site Tools


crpl:docs:showgameeventtag

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
crpl:docs:showgameeventtag [2020/09/01 13:16] nathanaelpscrpl:docs:showgameeventtag [2022/08/20 17:32] (current) Grabz
Line 1: Line 1:
-~~DISCUSSION~~+
 <- [[crpl:crplreference|CRPL reference]] <- [[crpl:crplreference#utility_commands|Utility Commands]] <- [[crpl:crplreference|CRPL reference]] <- [[crpl:crplreference#utility_commands|Utility Commands]]
 =====  ShowGameEventTag===== =====  ShowGameEventTag=====
- 
-<note warning>This page needs modifications. 
-  * Verify that all the arguments do what this article says they do 
-  * If they don't, change the article 
-  * Give more detail on what this command actually does 
-</note> 
  
 ^Arguments^Result^Notation^ ^Arguments^Result^Notation^
Line 14: Line 8:
  
 === Description === === Description ===
-(color, icon, line1, line2, targetPixelX, targetPixelY)+(backgroundcolor, icon, line1, line2, targetPixelX, targetPixelY)
  
 A command that takes six arguments and displays a message on-screen. The message goes into the game events list on the left, but since it's a game event it can be spammed and may often be turned off (in the game options), and this command is ineffective and silent. A command that takes six arguments and displays a message on-screen. The message goes into the game events list on the left, but since it's a game event it can be spammed and may often be turned off (in the game options), and this command is ineffective and silent.
  
-Argument 1 is the colour of the message, from "RED", "GREEN", "BLUE", "PURPLE", "CYAN", "YELLOW", "GRAY", "BLACK"+Argument 1 is the background color of the message, as a string. Permitted values are "RED", "GREEN", "BLUE", "PURPLE", "CYAN", "YELLOW", "GRAY", "BLACK"
  
-Argument 2 is the icon of the message, from "NONE", "INFO", "CRPLCORE", "COLLECTOR", "RELAY", "REACTOR", "SHIELD", "OREMINE" ,"SIPHON", "TERP", "GUPPY", "PULSECANNON", "MORTAR", "STRAFER", "BOMBER", "NULLIFIER", "SPRAYER", "BEAM", "SNIPER", "FORGE", "BERTHA", "THOR", "EMITTER", "ANTIEMITTER", "SPORETOWER", "RUNNERNEST", "AETOWER", "INHIBITOR", "POWERZONE", "OREDEPOSIT", "TOTEM", "MESSAGEARTIFACT", "SHIELDKEY", "RESOURCEPACK", "TECHARTIFACT", "AOO"+Argument 2 is the icon of the message, as a string. Permitted values are "NONE", "INFO", "CRPLCORE", "COLLECTOR", "RELAY", "REACTOR", "SHIELD", "OREMINE" ,"SIPHON", "TERP", "GUPPY", "PULSECANNON", "MORTAR", "STRAFER", "BOMBER", "NULLIFIER", "SPRAYER", "BEAM", "SNIPER", "FORGE", "BERTHA", "THOR", "EMITTER", "ANTIEMITTER", "SPORETOWER", "RUNNERNEST", "AETOWER", "INHIBITOR", "POWERZONE", "OREDEPOSIT", "TOTEM", "MESSAGEARTIFACT", "SHIELDKEY", "RESOURCEPACK", "TECHARTIFACT", "AOO"
  
-Arguments 3 and 4 are the two lines of the message to be displayed.+Arguments 3 and 4 are the two lines of the message to be displayed. The game event tag system has a very limited size, so it is advisable to check that your tag doesn't overflow the tag.
  
-Arguments 5 and 6 are the coords of the message to be displayed in floating point pixel space.+Arguments 5 and 6 are the pixel coordinates for the tag to point to, in floating point pixel space.
 === Examples === === Examples ===
  
 <code>#Creates a game event tag pointing to the current core's position <code>#Creates a game event tag pointing to the current core's position
-"RED" "INFO" "Line One" "Line Two" CurrentPixelCoords</code>+ShowGameEventTag("RED" "INFO" "Line One" "Line Two" CurrentPixelCoords)</code>
  
crpl/docs/showgameeventtag.1598980589.txt.gz · Last modified: 2020/09/01 13:16 by nathanaelps