Editing GetButtonPressed

=='''Description'''==
'''GetButtonPressed''' is used to determine which button has been selected after a message box has been displayed using [[ShowMessage]].
=='''Syntax:'''==
 GetButtonPressed 

=='''Example:'''==
 set buttonVar to GetButtonPressed 

The first time this is called after a [[ShowMessage]] button has been pressed, it returns the index of the button that was pressed, starting at zero. At all other times it returns -1.

'''Example'''
<pre>
Begin OnActivate
	showmessage ExampleMessage
	set awaitingInput to 1
end

begin gamemode
	if awaitingInput == 1
		set buttonVar to getbuttonpressed

		if buttonVar > -1
			set awaitingInput to 0

			if buttonVar == 0
				; choice 1
			elseif buttonVar == 1
				; choice 2
			elseif buttonVar == 2
				; choice 3
			endif
		endif
	endif
end
</pre>

==Notes==
* This will only react to a [[ShowMessage]] call from within the same script.
* The button indices are shown in the GECK when editing the message object and remain the same even if certain buttons are hidden with conditions.  So, if a Message has 3 buttons, GetButtonPressed will return '''2''' when the last one is pressed even if that is the only button actually being displayed.

=='''See Also'''==
[[ShowMessage]]

[[Category:Functions]]
[[Category:Functions (GECK 1.1)]]
[[Category:Miscellaneous Functions]]
[[Category:Miscellaneous Functions (GECK 1.1)]]