SetLevelTemplateName.md

SetLevelTemplateName

Description

Sets the name of the Story Level Template at 'index' to be 'name'.

FUNCTION SetLevelTemplateName(
				index : INTEGER;
				name  : STRING): BOOLEAN;

def vs.SetLevelTemplateName(index, name):
    return BOOLEAN

Parameters

Name	Type	Description
index	INTEGER	The index of the Story Level Template.
name	STRING	The new name for the Story Level Template at 'index'.

Examples

VAR

result : BOOLEAN;

BEGIN

result := SetLevelTemplateName(2, "Subfloor");

resultOK := SetLevelTemplateName(1, 'Example');

import vs

# Sets the name of the Story Level Template at 'index' to be 'name'.
index = 1
name = 'Example'

ok = vs.SetLevelTemplateName(index, name)
if ok:
    vs.Message('SetLevelTemplateName succeeded')
else:
    vs.Message('SetLevelTemplateName failed')

See Also

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

Version

Availability: from Vectorworks 2015

Category

• Layers