Skip to content

RemoveStoryLevel.md

Latest commit

 

History

History
68 lines (54 loc) · 1.73 KB

RemoveStoryLevel.md

File metadata and controls

68 lines (54 loc) · 1.73 KB
Raw

RemoveStoryLevel

Description

Removes the Story Level matching 'levelType' from a Story. If 'bDeleteLayer' is true and the Story Level has an associated layer, the layer will be deleted as well.

FUNCTION RemoveStoryLevel(
				storyHandle  : HANDLE;
				levelType    : STRING;
				bDeleteLayer : BOOLEAN): BOOLEAN;
def vs.RemoveStoryLevel(storyHandle, levelType, bDeleteLayer):
    return BOOLEAN

Parameters

Name Type Description
storyHandle HANDLE The handle of the story we want to deleted a Story Level from.
levelType STRING The level type of the Story Level we want to remove from 'storyHandle'.
bDeleteLayer BOOLEAN If this is true, and the requested Story Level has a layer associated with it, the layer will be deleted as well.

Examples

VAR

storyHandle : HANDLE
success:BOOLEAN

BEGIN

storyHandle := CreateStory('Floor 1', '-1');
success := RemoveStoryLevel(storyHandle, 'Finish Floor', TRUE);
resultOK := RemoveStoryLevel(storyHandle, 'Example', TRUE);
import vs

# Removes the Story Level matching 'levelType' from a Story.
storyHandle = vs.FSActLayer()  # handle to the first selected object on the active layer
levelType = 'Example'
bDeleteLayer = True

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

See Also

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

Version

Availability: from Vectorworks 2015

Category