Returns a list of edges for which the agent is a startpoint.
Parameters
kind — str, optional
The connection kind in which to find outbound edges. Set to
None
to return all outbound edges of all types.Default value: 'edge'
undirected — bool, optional
Whether to include undirected edges in the result (i.e. whether to understand directionless edges as having no direction or both directions).
Default value: False
obj — str, optional
If
obj=='edge'
, returns a list of Edge objects. Ifobj=='agent'
, returns a list of partner agents corresponding to the edges.Default value: 'edge'
Return Value — list[Edge|Agent]
A list of outbound edges, or the agents corresponding to them, depending on the value of obj
.
Notes and Examples