Difference between revisions of "cock.getEmptyOption"

(Created page with "Finds next (in arbitrary order) unused input option in current layout. == Synopsis == === Function === <source lang="Lua">option = cock.getEmptyOption ( self )</source> === Argum...")
 
m
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
 
== Synopsis ==
 
== Synopsis ==
 
=== Function ===
 
=== Function ===
<source lang="Lua">option = cock.getEmptyOption ( self )</source>
+
<source lang="Lua">option = cock.getEmptyOption ( self, map )</source>
 
=== Arguments ===
 
=== Arguments ===
 
{{param|table|self|An object to use.}}
 
{{param|table|self|An object to use.}}
 +
{{param|string|map|A control mapping to find unused options for.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|string|option|Found unused option (nil on failure).}}
 
{{param|string|option|Found unused option (nil on failure).}}
Line 15: Line 16:
 
*[[Common Organization of Controls Kit]]
 
*[[Common Organization of Controls Kit]]
  
{{#set:Description=Deletes input option.}}
+
{{#set:Description=Finds unused option.}}

Latest revision as of 15:00, 2 September 2013

Finds next (in arbitrary order) unused input option in current layout.

Synopsis

Function

option = cock.getEmptyOption ( self, map )

Arguments

table self
An object to use.
string map
A control mapping to find unused options for.

Returns

string option
Found unused option (nil on failure).

See also