NameData - DauntlessStudio/Bedrock-Developments GitHub Wiki

Class: NameData

Remarks

A class for working with name data like identifiers.

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new NameData(name): NameData

Parameters

Name Type Description
name string The source string to create namedata from.

Returns

NameData

Remarks

Creates a namedata object from a source string.

Example

let name = new NameData("subfolder/minecraft:test");

Defined in

ts/app/utils.ts:74

Properties

directory

directory: string

Remarks

The directory name of the source string, i.e. subfolder/.

Defined in

ts/app/utils.ts:50


display

display: string

Remarks

The display name of the source string as used in the lang, i.e. Test.

Defined in

ts/app/utils.ts:45


fullname

fullname: string

Remarks

The full identifier of the source string, i.e. minecraft:test.

Defined in

ts/app/utils.ts:30


namespace

namespace: string

Remarks

The namespace of the source stirng, i.e. minecraft:test.

Defined in

ts/app/utils.ts:35


original

original: string

Remarks

The original source string, i.e. subfolder/minecraft:test.

Defined in

ts/app/utils.ts:25


shortname

shortname: string

Remarks

The shortname of the source string, i.e. test from either minecraft:test or geometry.test.

Defined in

ts/app/utils.ts:40


projectName

Static Private projectName: string = ''

Defined in

ts/app/utils.ts:20


teamName

Static Private teamName: string = ''

Defined in

ts/app/utils.ts:19

Accessors

ProjectName

get ProjectName(): string

Returns

string

Remarks

The name of the Project

Defined in

ts/app/utils.ts:62


TeamName

get TeamName(): string

Returns

string

Remarks

The name of the development team.

Defined in

ts/app/utils.ts:55

Methods

splitWords

splitWords(name): string[]

Parameters

Name Type
name string

Returns

string[]

Defined in

ts/app/utils.ts:97


setAddonNamespace

setAddonNamespace(namespace): void

Parameters

Name Type
namespace string

Returns

void

Defined in

ts/app/utils.ts:102

⚠️ **GitHub.com Fallback** ⚠️