Skip to content

Commit 3ef6acc

Browse files
committed
Making readme more legible
1 parent 40364dc commit 3ef6acc

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -66,20 +66,19 @@ ICompoundCommandConfig - returned when mapping / unmapping - has the API:
6666

6767
function addRequiredEvent(eventType:String, eventClass:Class = null, named:String = ""):ICompoundCommandConfig;
6868

69-
// all events set using addRequiredEvent
70-
function get requiredEvents():Array;
69+
function get requiredEvents():Array; // all events set using addRequiredEvent
70+
71+
function get remainingRequiredEvents():Array; // events that have not yet fired
7172

72-
// events that have not yet fired
73-
function get remainingRequiredEvents():Array;
73+
function get requiredInOrder():Boolean; /* whether the events are only picked up in order -
74+
ie event2 is ignored until after event1 is received */
7475

75-
// whether the events are only picked up in order - ie event2 is ignored until after event1 is received
76-
function get requiredInOrder():Boolean;
76+
function get eventsAsPayloads():Array; /* returns an array of the events that have arrived so
77+
far as a strong typed IEventAsPayload with 3 properties:
78+
the event, the event class and the event name,
79+
if it was mapped with a name */
7780

78-
/* returns an array of the events that have arrived so far as a strong typed IEventAsPayload with 3 properties:
79-
the event, the event class and the event name if it was mapped with a name */
80-
function get eventsAsPayloads():Array;
81-
82-
function get oneshot():Boolean;
81+
function get oneshot():Boolean; // whether this command is unmapped after one execution
8382

8483

8584
See tests/org/robotlegs/base/CompoundCommandMapTest for full usage examples.

0 commit comments

Comments
 (0)