path_set(ENTITY* entity,STRING* name)

Attaches the given entity to the path with the given name. A8.13 If an empty name string is given, the string is set to the WED name of the path the entity is currently attached to (if any). If NULL is given for the name, the entity is detached from its previous path.

Parameters:

entity - entity pointer.
name - path name (STRING* or char*), NULL, or pointer to an empty STRING.

Returns:

Number of nodes in the path, or 0 if the path was not found.

Speed:

Fast

Modifies:

entity - is attached to or detached from the path.

Example:

path_set(me,"path_001");

See also:

path_create, path_scan, path_next, path_nextnode

► latest version online