Skip to content

SetLevelElevation.md

Latest commit

 

History

History
56 lines (46 loc) · 1.36 KB

SetLevelElevation.md

File metadata and controls

56 lines (46 loc) · 1.36 KB
Raw

SetLevelElevation

Description

Sets the elevation of a Story Level relative to its Story.

FUNCTION SetLevelElevation(
				storyHandle  : HANDLE;
				levelType    : STRING;
				newElevation : REAL): BOOLEAN;
def vs.SetLevelElevation(storyHandle, levelType, newElevation):
    return BOOLEAN

Parameters

Name Type Description
storyHandle HANDLE The handle of the Story with the desired Story Level.
levelType STRING The level type of the Story Level to change the elevation of.
newElevation REAL The new elevation for the Story Level.

Examples

resultOK := SetLevelElevation(storyHandle, 'Example', 1.0);
import vs

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

ok = vs.SetLevelElevation(storyHandle, levelType, newElevation)
if ok:
    vs.Message('SetLevelElevation succeeded')
else:
    vs.Message('SetLevelElevation failed')

See Also

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

Version

Availability: from Vectorworks 2015

Category