regcldcookie( sectionname, priority )


Parameters

  Type Description
sectionname section name of a section
priority numeric event priority

_result

Not set.

Descriptions

Registers the section specified by sectionname to handle cookie collision events. The cookie collision event handler is called if no higher priority events are occurring when a robot runs into an energy cookie.  

Cookie collision events are triggered by the _cldcookie variable. When a cookie collision event handler completes, the _cldcookie variable is automatically set to false causing the event to end. When a robot collides with any obstacle the following system variables are updated to provide information about the collision: _cldbearing, _cldheading, _cldenergy, _cldid, and _cldteamid. Robots only track information about the most recent collision event, causing all _cld variables to be reset for each collision. 

The priority value should be a whole number, decimals are ignored. Lower numbers are higher priority. The highest priority possible is 1. If two events registered with the same priority occur at the same time, it is unspecified which event handler will be called. 

When an event handler is registered or re-registered, it becomes immediately active. Use the cldcookieevents command to temporarily deactivate a registered event handler.

See Also

cldcookieevents, _cldcookie, _cldbearing, _cldheading, _cldenergy, _cldid, _cldteamid, event summary