env_gmbutton_ow

Entity Description

This point based entity is used to display a button on the GM's GUI as a sprite. The sprite is rendered on the GUI but is dynamically positioned above this entity in the GM's view of the map. The GM can click the sprite to trigger this entity.


Key Values

• Targetname:
  Name <targetname>
  The targetname other entities refer to this entity by.
  
  
• Parentname:
  Parent <targetname>
  Specifies the targetname of this entity's movement parent. Entities with parents move with their parent.
  
  
• Charges:
  Charges <integer>
  How many times can this be used.
  
  
• Cooldown:
  Cooldown <float>
  Time in seconds after activated until it can be used again.
  
  
• Initial Cooldown:
  Initial Cooldown <float>
  The cooldown that is applied to the button when it is created. Can be set higher than the normal cooldown.
  
  
• TooltipTitle:
  Tooltip Title <string>
  Text that is shown as the button's tooltip title.
  
  
• Tooltip:
  Tooltip <string>
  Text that is shown on the button's tooltip.
  
  
• ButSize:
  Button Minimum Size <integer>
  Minimum size of the button to be displayed at minimum zoom level.
  
  
• ButSizeMax:
  Button Maximum Size <integer>
  Maximum size of the button to be displayed at maximum zoom level.
  
  
• MatEnable:
  Enabled Material <string>
  Material used when button is enabled.
  
  
• MatCooldown:
  Cooldown Material <string>
  Material used when button is in cooldown.
  
  
• MatDisable:
  Disabled Material <string>
  Material used when button is disabled.
  
  
• MatPressed:
  Pressed Material <string>
  Material used when button is pressed.
  
  
• MatMouseOver:
  Mouse Over Material <string>
  Material used when the mouse is over the button.
  
  
• ClrEnable:
  Enabled Color <color255>
  Color used on the material when button is enabled.
  
  
• ClCooldown:
  Cooldown Color <color255>
  Color used on the material when button is in cooldown.
  
  
• ClrDisable:
  Disabled Color <color255>
  Color used on the material when button is disabled.
  
  
• ClrPressed:
  Pressed Color <color255>
  Color used on the material when button is pressed.
  
  
• ClrMouseOver:
  Mouse Over Color <color255>
  Color used on material when the mouse is over the button.

Inputs

• SetTooltipTitle <string>
  Changes the button's tooltip title.
  
  
• SetTooltip <string>
  Changes the button's tooltip.
  
  
• SetCooldown <float>
  Sets the cooldown time
  
  
• ForceCooldown <float>
  Force a cooldown with set amount
  
  
• ForceCooldownAdd <float>
  Add time to an active cooldown. Does nothing if there isn't an active cooldown.
  
  
• ForceCooldownSubtract <float>
  Subtract time from an active cooldown. Does nothing if there isn't an active cooldown.
  
  
• SetCharges <integer>
  Set number of charges left.
  
  
• ChargesAdd <integer>
  Add more charges.
  
  
• ChargesSubtract <integer>
  Subtract charges.

Outputs

• OnPressed
  Fired when the GM presses this button.
  
  
• OnCooldownFinished
  Fired when the cooldown has expired.
  
  
• OnChargesExpired
  Fired when all charges has expired.

Revision History

• 29 SEP 2010 - Added the "Cooldown Material" and "Cooldown Color" keys.