li.cil.tis3d.common.item

Class CodeBookItem.Data

java.lang.Object

li.cil.tis3d.common.item.CodeBookItem.Data

Enclosing class:

CodeBookItem

public static class CodeBookItem.Data
extends java.lang.Object

Wrapper for list of pages stored in the code book.

Constructor Summary

Constructors

Constructor and Description
Data()

Method Summary

Modifier and Type	Method and Description
void	addOrSelectProgram(java.util.List<java.lang.String> code) Add a new program to the book.
void	addPage() Add a new, blank page to the book.
void	getExtendedProgram(int page, java.util.List<java.lang.String> program, java.util.List<java.lang.String> leadingCode, java.util.List<java.lang.String> trailingCode) Get the leading and trailing code lines of a program spanning the specified page, taking into account the #BWTM preprocessor marco.
java.util.List<java.lang.String>	getPage(int index) Get the code on the specified page.
int	getPageCount() Get the number of pages stored in the book.
java.util.List<java.lang.String>	getProgram() Get the complete program of the selected page, taking into account the #BWTM preprocessor macro allowing programs to span multiple pages.
int	getSelectedPage() Get the page currently selected in the book.
static CodeBookItem.Data	loadFromNBT(net.minecraft.nbt.CompoundTag nbt) Load code book data from the specified NBT tag.
static CodeBookItem.Data	loadFromStack(net.minecraft.item.ItemStack stack) Load code book data from the specified item stack.
void	readFromNBT(net.minecraft.nbt.CompoundTag nbt) Load data from the specified NBT tag.
void	removePage(int index) Remove a page from the book.
static void	saveToStack(net.minecraft.item.ItemStack stack, CodeBookItem.Data data) Save the specified code book data to the specified item stack.
void	setPage(int page, java.util.List<java.lang.String> code) Overwrite a page at the specified index.
void	setSelectedPage(int index) Set which page is currently selected.
void	writeToNBT(net.minecraft.nbt.CompoundTag nbt) Store the data to the specified NBT tag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Data

public Data()

Method Detail

getSelectedPage

public int getSelectedPage()

Get the page currently selected in the book.

Returns:

the index of the selected page.

setSelectedPage

public void setSelectedPage(int index)

Set which page is currently selected.

Parameters:

index - the new selected index.

getPageCount

public int getPageCount()

Get the number of pages stored in the book.

Returns:

the number of pages stored in the book.

getPage

public java.util.List<java.lang.String> getPage(int index)

Get the code on the specified page.

Parameters:

index - the index of the page to get the code of.

Returns:

the code on the page.

addPage

public void addPage()

Add a new, blank page to the book.

addOrSelectProgram

public void addOrSelectProgram(java.util.List<java.lang.String> code)

Add a new program to the book.

Depending on the size of the program, this will generate multiple pages and automatically insert #BWTM preprocessor macros as necessary (when they're not already there).

If the provided program is already present in the code book letter by letter, then instead of adding the provided code, the already present program will be selected instead.

Parameters:

code - the code to add or select.

setPage

public void setPage(int page,
                    java.util.List<java.lang.String> code)

Overwrite a page at the specified index.

Parameters:

page - the index of the page to overwrite.

code - the code of the page.

removePage

public void removePage(int index)

Remove a page from the book.

Parameters:

index - the index of the page to remove.

getProgram

public java.util.List<java.lang.String> getProgram()

Get the complete program of the selected page, taking into account the #BWTM preprocessor macro allowing programs to span multiple pages.

Returns:

the full program starting on the current page.

getExtendedProgram

public void getExtendedProgram(int page,
                               java.util.List<java.lang.String> program,
                               java.util.List<java.lang.String> leadingCode,
                               java.util.List<java.lang.String> trailingCode)

Get the leading and trailing code lines of a program spanning the specified page, taking into account the #BWTM preprocessor marco. This assumes that the specified page does have the #BWTM preprocessor macro. I.e. the next page will always be added to the trailingPages.

Parameters:

page - the page to extend from.

program - the code on the page to extend from.

leadingCode - the list to place code from previous pages into.

trailingCode - the list to place code from next pages into.

readFromNBT

public void readFromNBT(net.minecraft.nbt.CompoundTag nbt)

Load data from the specified NBT tag.

Parameters:

nbt - the tag to load the data from.

writeToNBT

public void writeToNBT(net.minecraft.nbt.CompoundTag nbt)

Store the data to the specified NBT tag.

Parameters:

nbt - the tag to save the data to.

loadFromNBT

public static CodeBookItem.Data loadFromNBT(@Nullable
                                            net.minecraft.nbt.CompoundTag nbt)

Load code book data from the specified NBT tag.

Parameters:

nbt - the tag to load the data from.

Returns:

the data loaded from the tag.

loadFromStack

public static CodeBookItem.Data loadFromStack(net.minecraft.item.ItemStack stack)

Load code book data from the specified item stack.

Parameters:

stack - the item stack to load the data from.

Returns:

the data loaded from the stack.

saveToStack

public static void saveToStack(net.minecraft.item.ItemStack stack,
                               CodeBookItem.Data data)

Save the specified code book data to the specified item stack.

Parameters:

stack - the item stack to save the data to.

data - the data to save to the item stack.