Skip to content

elevation

Syntax

elevation()
elevation(place_name)

Parameters

place_name
The name of a place that the agent can visit.

Returns

With no argument, this returns the elevation of the agent itself.

If place_name is given, then the elevation of the agent's site for this place is returned.

Description

This action returns the elevation of the agent itself if no argument is given.

Otherwise it returns the elevation of the agent's site for the given place name. For example, elevation(Workplace) returns the elevation of the agent's specific Workplace site.

If a place parameter is provided, it is an error if the agent is not a member of that place.

Important

An agent's coordinates are not updated unless the agent has been explicitly moved using a move-related action.

Examples

This statement returns the elevation of the agent's school

elevation(School)

See Also