Difference between revisions of "Thread:peek"

m
Line 4: Line 4:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
value = Thread:peek(name)
+
value = Thread:peek( name )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===

Revision as of 01:10, 27 November 2012

Available since LÖVE 0.7.0
This function is not supported in earlier versions.

Retrieves the value of a message, but leaves it in the thread's message box. The name of the message can be any string. The value of the message can be a boolean, string, number or a LÖVE userdata. It returns nil, if there's no message with the given name.

Function

Synopsis

value = Thread:peek( name )

Arguments

string name
The name of the message.

Returns

boolean, number, string or LÖVE userdata value
The contents of the message.

See Also

Other Languages