Skip to content

SetStoryElevationN.md

Latest commit

 

History

History
50 lines (40 loc) · 1.23 KB

SetStoryElevationN.md

File metadata and controls

50 lines (40 loc) · 1.23 KB
Raw

SetStoryElevationN

Description

Sets the elevation of the indicated Story. Returns whether the elevation was successfully set. If the elevaton change would cause Layers associated with the Story to overlap Layers associated with another Story, then the change in elevation will be prevented.

FUNCTION SetStoryElevationN(
				story     : HANDLE;
				elevation : REAL): BOOLEAN;
def vs.SetStoryElevationN(story, elevation):
    return BOOLEAN

Parameters

Name Type Description
story HANDLE The Story whose elevation is to be set.
elevation REAL The elevation to set the Story to. The elevation is in document units.

Examples

resultOK := SetStoryElevationN(story, 1.0);
import vs

# Sets the elevation of the indicated Story.
story = vs.FSActLayer()  # handle to the first selected object on the active layer
elevation = 0.0

ok = vs.SetStoryElevationN(story, elevation)
if ok:
    vs.Message('SetStoryElevationN succeeded')
else:
    vs.Message('SetStoryElevationN failed')

See Also

VS Functions: CreateStory | GetStoryElevationN

Version

Availability: from Vectorworks 2025

Category