Skip to content

GetStoryBelow.md

Latest commit

 

History

History
73 lines (57 loc) · 1.56 KB

GetStoryBelow.md

File metadata and controls

73 lines (57 loc) · 1.56 KB
Raw

GetStoryBelow

Description

Returns the Story below the indicated Story. Returns NULL if there is none. If passed a NULL handle, returns the bottom-most Story in the current drawing.

FUNCTION GetStoryBelow(story : HANDLE): HANDLE;
def vs.GetStoryBelow(story):
    return HANDLE

Parameters

Name Type Description
story HANDLE The indicated Story for which the Story below it is desired

Examples

VAR

baseStory:HANDLE;
storyBelow:HANDLE;

BEGIN

baseStory := GetStoryOfLayer(ActLayer);
storyBelow := StoryBelow(baseStory);
BEGIN
	storyH := GetStoryBelow( storyH );
END;

{ Find the story we are currently working on }
hStory := GetStoryBelow( NIL );
storySuffix := GetStorySuffix( hStory );
WHILE (( storySuffix  <> TmpLayerSuffix ) AND ( hStory <> NIL ) ) DO BEGIN
	hStory := GetStoryAbove( hStory );
	if ( hStory <> NIL ) THEN BEGIN

3: BEGIN
	story := GetStoryBelow(NIL);
	WHILE story <> NIL DO BEGIN
		AddChoice(dialogID, 10, GetStorySuffix(story), 0);
		story := GetStoryAbove(story);
	END;
import vs

# Returns the Story below the indicated Story.
story = vs.FSActLayer()  # handle to the first selected object on the active layer

objHandle = vs.GetStoryBelow(story)
if objHandle is not None:
    vs.Message('Created object handle: ' + str(objHandle))

See Also

VS Functions: GetStoryAbove | GetNumStories | GetStoryOfLayer

Version

Availability: from Vectorworks 2012

Category