Skip to content

GetStoryLayerInfo.md

Latest commit

 

History

History
57 lines (48 loc) · 1.72 KB

GetStoryLayerInfo.md

File metadata and controls

57 lines (48 loc) · 1.72 KB
Raw

GetStoryLayerInfo

Description

Returns information on the given story layer template

FUNCTION GetStoryLayerInfo(
				index                 : INTEGER;
				VAR name              : STRING;
				VAR scaleFactor       : REAL;
				VAR layerLevelType    : STRING;
				VAR eleveationOffset  : REAL;
				VAR defaultWallHeight : REAL): Boolean;
def vs.GetStoryLayerInfo(index):
    return (Boolean, name, scaleFactor, layerLevelType, eleveationOffset, defaultWallHeight)

Parameters

Name Type Description
index INTEGER Index of story.
name STRING Returns with Name of story layer template
scaleFactor REAL Returns with Scale Factor of story layer template
layerLevelType STRING Returns with Level Type of story layer template
eleveationOffset REAL Returns with the Elevation Offset of story layer template
defaultWallHeight REAL Returns with the Default Wall Height of story layer template

Examples

foundLevelType := FALSE;
foundLevel := 0;
storyTemplates := GetNumStoryLayerTemplates;
for storyIndex := 1 to storyTemplates DO BEGIN
	OK := GetStoryLayerInfo( storyIndex, levelName, levelScale, levelType, levelElev, levelWallHeight );
	if levelType = storyLevel THEN BEGIN
		foundLevelType := TRUE;
		foundLevel := storyIndex;
	END
import vs

# Returns information on the given story layer template.
index = 1

ok, name, scaleFactor, layerLevelType, eleveationOffset, defaultWallHeight = vs.GetStoryLayerInfo(index)
vs.Message('GetStoryLayerInfo returned: ' + str((ok, name, scaleFactor, layerLevelType, eleveationOffset, defaultWallHeight)))

Version

Availability: from Vectorworks 2012

Category