Skip to content

GetLevelTemplateName.md

Latest commit

 

History

History
56 lines (42 loc) · 1.17 KB

GetLevelTemplateName.md

File metadata and controls

56 lines (42 loc) · 1.17 KB
Raw

GetLevelTemplateName

Description

Returns the name of the nth Story Level Template in the file. For example, if 3 is passed in, it will return the name of the 3rd Story Level Template in the file.

FUNCTION GetLevelTemplateName(index : INTEGER): STRING;
def vs.GetLevelTemplateName(index):
    return STRING

Parameters

Name Type Description
index INTEGER The index of the Story Level Template whose name is to be returned.

Examples

VAR

templateName:STRING;

BEGIN

templateName:=GetLevelTemplateName(2);
resultStr := GetLevelTemplateName(1);
import vs

# Returns the name of the nth Story Level Template in the file.
index = 1

name = vs.GetLevelTemplateName(index)
vs.Message('GetLevelTemplateName returned: ' + str(name))

See Also

VS Functions: GetNumLevelTemplates | SetLevelTemplateName | CreateLevelTemplate | DeleteLevelTemplate | GetLevelTemplateInfo

Version

Availability: from Vectorworks 2015

Category