Skip to content

GetLevelElevation.md

Latest commit

 

History

History
50 lines (40 loc) · 1.25 KB

GetLevelElevation.md

File metadata and controls

50 lines (40 loc) · 1.25 KB
Raw

GetLevelElevation

Description

Gets the elevation of a Story Level, relative to its containing Story.

FUNCTION GetLevelElevation(
				storyHandle : HANDLE;
				levelType   : STRING): REAL;
def vs.GetLevelElevation(storyHandle, levelType):
    return REAL

Parameters

Name Type Description
storyHandle HANDLE The handle of the Story containing the Story Level we would like to know the elevation of.
levelType STRING The level type of the Story Level that we would like to know the elevation of.

Examples

resultVal := GetLevelElevation(storyHandle, 'Example');
import vs

# Gets the elevation of a Story Level, relative to its containing Story.
storyHandle = vs.FSActLayer()  # handle to the first selected object on the active layer
levelType = 'Example'

value = vs.GetLevelElevation(storyHandle, levelType)
vs.Message('GetLevelElevation returned: ' + str(value))

See Also

VS Functions: CreateStory | AddStoryLevel | RemoveStoryLevel | AddLevelFromTemplate | SetLevelElevation

Version

Availability: from Vectorworks 2015

Category