Skip to content

DeleteLevelTemplate.md

Latest commit

 

History

History
59 lines (45 loc) · 1.18 KB

DeleteLevelTemplate.md

File metadata and controls

59 lines (45 loc) · 1.18 KB
Raw

DeleteLevelTemplate

Description

Deletes the nth Story Level Template from the current file. For example, if 3 is passed in, it will delete the 3rd Story Level Template in the file.

FUNCTION DeleteLevelTemplate(index : INTEGER): BOOLEAN;
def vs.DeleteLevelTemplate(index):
    return BOOLEAN

Parameters

Name Type Description
index INTEGER The index of the Story Level Template to be deleted.

Examples

VAR

success:BOOLEAN;

BEGIN

success := DeleteLevelTemplate(3);
resultOK := DeleteLevelTemplate(1);
import vs

# Deletes the nth Story Level Template from the current file.
index = 1

ok = vs.DeleteLevelTemplate(index)
if ok:
    vs.Message('DeleteLevelTemplate succeeded')
else:
    vs.Message('DeleteLevelTemplate failed')

See Also

VS Functions: GetNumStoryTemplates | GetLevelTemplateName | SetLevelTemplateName | CreateLevelTemplate | GetLevelTemplateInfo

Version

Availability: from Vectorworks 2015

Category