JSPrismarine

API reference / @jsprismarine/brigadier / StringReader

Class: StringReader ​

Defined in: StringReader.ts:8

Implements ​

  • default

Constructors ​

Constructor ​

new StringReader(other): StringReader

Defined in: StringReader.ts:12

Parameters ​

other ​

string | StringReader

Returns ​

StringReader

Methods ​

canRead() ​

canRead(length?): boolean

Defined in: StringReader.ts:49

Parameters ​

length? ​

number = 1

Returns ​

boolean

Implementation of ​

ImmutableStringReader.canRead

expect() ​

expect(c): void

Defined in: StringReader.ts:189

Parameters ​

c ​

string

Returns ​

void

getCursor() ​

getCursor(): number

Defined in: StringReader.ts:37

Returns ​

number

Implementation of ​

ImmutableStringReader.getCursor

getRead() ​

getRead(): string

Defined in: StringReader.ts:41

Returns ​

string

Implementation of ​

ImmutableStringReader.getRead

getRemaining() ​

getRemaining(): string

Defined in: StringReader.ts:45

Returns ​

string

Implementation of ​

ImmutableStringReader.getRemaining

getRemainingLength() ​

getRemainingLength(): number

Defined in: StringReader.ts:29

Returns ​

number

Implementation of ​

ImmutableStringReader.getRemainingLength

getString() ​

getString(): string

Defined in: StringReader.ts:21

Returns ​

string

Implementation of ​

ImmutableStringReader.getString

getTotalLength() ​

getTotalLength(): number

Defined in: StringReader.ts:33

Returns ​

number

Implementation of ​

ImmutableStringReader.getTotalLength

peek() ​

peek(offset?): string

Defined in: StringReader.ts:53

Parameters ​

offset? ​

number = 0

Returns ​

string

Implementation of ​

ImmutableStringReader.peek

read() ​

read(): string

Defined in: StringReader.ts:57

Returns ​

string

readBoolean() ​

readBoolean(): boolean

Defined in: StringReader.ts:172

Returns ​

boolean

readFloat() ​

readFloat(): number

Defined in: StringReader.ts:93

Returns ​

number

readInt() ​

readInt(): number

Defined in: StringReader.ts:75

Returns ​

number

readQuotedString() ​

readQuotedString(): string

Defined in: StringReader.ts:132

Returns ​

string

readString() ​

readString(): string

Defined in: StringReader.ts:164

Returns ​

string

readUnquotedString() ​

readUnquotedString(): string

Defined in: StringReader.ts:123

Returns ​

string

setCursor() ​

setCursor(cursor): void

Defined in: StringReader.ts:25

Parameters ​

cursor ​

number

Returns ​

void

skip() ​

skip(): void

Defined in: StringReader.ts:61

Returns ​

void

skipWhitespace() ​

skipWhitespace(): void

Defined in: StringReader.ts:69

Returns ​

void

isAllowedInUnquotedString() ​

static isAllowedInUnquotedString(c): boolean

Defined in: StringReader.ts:111

Parameters ​

c ​

string

Returns ​

boolean

isAllowedNumber() ​

static isAllowedNumber(c): boolean

Defined in: StringReader.ts:65

Parameters ​

c ​

string

Returns ​

boolean