# MCImmutableStringReader

## Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.
```zenscript
import crafttweaker.api.commands.custom.MCImmutableStringReader;
```


## Methods

:::group{name=canRead}

Return Type: boolean

```zenscript
// MCImmutableStringReader.canRead() as boolean

myMCImmutableStringReader.canRead();
```

:::

:::group{name=canRead}

Return Type: boolean

```zenscript
MCImmutableStringReader.canRead(arg0 as int) as boolean
```

| Parameter | Type | Description |
|-----------|------|-------------|
| arg0 | int | No Description Provided |


:::

:::group{name=getCursor}

Return Type: int

```zenscript
// MCImmutableStringReader.getCursor() as int

myMCImmutableStringReader.getCursor();
```

:::

:::group{name=getRead}

Return Type: string

```zenscript
// MCImmutableStringReader.getRead() as string

myMCImmutableStringReader.getRead();
```

:::

:::group{name=getRemaining}

Return Type: string

```zenscript
// MCImmutableStringReader.getRemaining() as string

myMCImmutableStringReader.getRemaining();
```

:::

:::group{name=getRemainingLength}

Return Type: int

```zenscript
// MCImmutableStringReader.getRemainingLength() as int

myMCImmutableStringReader.getRemainingLength();
```

:::

:::group{name=getString}

Return Type: string

```zenscript
// MCImmutableStringReader.getString() as string

myMCImmutableStringReader.getString();
```

:::

:::group{name=getTotalLength}

Return Type: int

```zenscript
// MCImmutableStringReader.getTotalLength() as int

myMCImmutableStringReader.getTotalLength();
```

:::

:::group{name=peek}

Return Type: char

```zenscript
// MCImmutableStringReader.peek() as char

myMCImmutableStringReader.peek();
```

:::

:::group{name=peek}

Return Type: char

```zenscript
MCImmutableStringReader.peek(arg0 as int) as char
```

| Parameter | Type | Description |
|-----------|------|-------------|
| arg0 | int | No Description Provided |


:::


