li.cil.oc.api.component

Interface TextBuffer

All Superinterfaces:

Environment, ManagedEnvironment, Persistable

public interface TextBuffer
extends ManagedEnvironment, Persistable

This interface implements functionality for displaying and manipulating text, like screens and robots. An implementation can be obtained via the screens' item driver.

This allows re-using the built-in screen logic in third-party code without access to the internals of OC.

To get an instance of the buffer component, use its item driver, e.g.:

     final ItemStack stack = li.cil.oc.api.Items.get("screen1").createItemStack(1);
     final TextBuffer buffer = (TextBuffer) li.cil.oc.api.Driver.driverFor(stack).createEnvironment(stack, this);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TextBuffer.ColorDepth Used when setting a buffer's maximum color depth.

Method Summary

Methods

Modifier and Type	Method and Description
void	clipboard(java.lang.String value, net.minecraft.entity.player.EntityPlayer player) Signals a clipboard paste event for the buffer.
void	copy(int column, int row, int width, int height, int horizontalTranslation, int verticalTranslation) Copy a portion of the text buffer.
void	fill(int column, int row, int width, int height, char value) Fill a portion of the text buffer.
char	get(int column, int row) Get the character in the text buffer at the specified location.
double	getAspectRatio() Get the aspect ratio of the buffer.
int	getBackgroundColor() The active background color.
int	getBackgroundColor(int column, int row) Get the background color of the text buffer at the specified location.
TextBuffer.ColorDepth	getColorDepth() Get the active color depth of this buffer.
double	getEnergyCostPerTick() Get the energy cost per tick.
int	getForegroundColor() The active foreground color.
int	getForegroundColor(int column, int row) Get the foreground color of the text buffer at the specified location.
int	getHeight() Get the current vertical resolution.
TextBuffer.ColorDepth	getMaximumColorDepth() Get the maximum color depth supported.
int	getMaximumHeight() Get the maximum vertical size of the buffer.
int	getMaximumWidth() Get the maximum horizontal size of the buffer.
int	getPaletteColor(int index) Get the color in the active color palette at the specified index.
boolean	getPowerState() Get the current power state.
int	getWidth() Get the current horizontal resolution.
boolean	isBackgroundFromPalette() true if the background color is from the color palette, meaning the value returned from getBackgroundColor() is the color palette index.
boolean	isBackgroundFromPalette(int column, int row) Whether the background color of the text buffer at the specified location if from the color palette.
boolean	isForegroundFromPalette() true if the foreground color is from the color palette, meaning the value returned from getForegroundColor() is the color palette index.
boolean	isForegroundFromPalette(int column, int row) Whether the foreground color of the text buffer at the specified location if from the color palette.
boolean	isRenderingEnabled() Gets whether the contents of the buffer should currently be rendered.
void	keyDown(char character, int code, net.minecraft.entity.player.EntityPlayer player) Signals a key down event for the buffer.
void	keyUp(char character, int code, net.minecraft.entity.player.EntityPlayer player) Signals a key up event for the buffer.
void	mouseDown(int x, int y, int button, net.minecraft.entity.player.EntityPlayer player) Signals a mouse button down event for the buffer.
void	mouseDrag(int x, int y, int button, net.minecraft.entity.player.EntityPlayer player) Signals a mouse drag event for the buffer.
void	mouseScroll(int x, int y, int delta, net.minecraft.entity.player.EntityPlayer player) Signals a mouse wheel scroll event for the buffer.
void	mouseUp(int x, int y, int button, net.minecraft.entity.player.EntityPlayer player) Signals a mouse button release event for the buffer.
int	renderHeight() The natural height of the rendered text.
boolean	renderText() Renders the text displayed on the buffer.
int	renderWidth() The natural width of the rendered text.
void	set(int column, int row, java.lang.String value, boolean vertical) Write a string into the text buffer.
void	setAspectRatio(double width, double height) Set the 'aspect ratio' of the buffer.
void	setBackgroundColor(int color) Set the active background color, not using a palette.
void	setBackgroundColor(int color, boolean isFromPalette) Set the active background color.
boolean	setColorDepth(TextBuffer.ColorDepth depth) Set the active color depth for this buffer.
void	setEnergyCostPerTick(double value) Controls how much energy the buffer will consume per tick.
void	setForegroundColor(int color) Set the active foreground color, not using a palette.
void	setForegroundColor(int color, boolean isFromPalette) Set the active foreground color.
void	setMaximumColorDepth(TextBuffer.ColorDepth depth) Sets the maximum color depth supported by this buffer.
void	setMaximumResolution(int width, int height) Sets the maximum resolution supported by this buffer.
void	setPaletteColor(int index, int color) Set the color of the active color palette at the specified index.
void	setPowerState(boolean value) Set whether the buffer is powered on.
void	setRenderingEnabled(boolean enabled) Set whether the contents of the buffer should currently be rendered.
boolean	setResolution(int width, int height) Set the buffer's active resolution.

Methods inherited from interface li.cil.oc.api.network.ManagedEnvironment

canUpdate, update

Methods inherited from interface li.cil.oc.api.network.Environment

node, onConnect, onDisconnect, onMessage

Methods inherited from interface li.cil.oc.api.Persistable

load, save

Method Detail

setEnergyCostPerTick

void setEnergyCostPerTick(double value)

Controls how much energy the buffer will consume per tick.

This is not necessarily the actual amount consumed per tick, instead it is a base value that cost is based on, incorporating a few other factors. This is the cost a tier one screen will consume if every character is lit (non-black). Larger buffers (i.e. buffers with a higher maximum resolution) cost proportionally more.

Note that this amount of energy is not necessarily subtracted each tick, instead every n ticks, n times the amount of energy it costs to run the buffer will be consumed, where n is configurable in the OC config.

This defaults to OC's built-in default value.

Parameters:

value - the base energy cost per tick.

See Also:

getEnergyCostPerTick()

getEnergyCostPerTick

double getEnergyCostPerTick()

Get the energy cost per tick.

Returns:

the base energy cost per tick.

See Also:

setEnergyCostPerTick(double)

setPowerState

void setPowerState(boolean value)

Set whether the buffer is powered on.

For example, screens can be powered on and off by sending a redstone pulse into them, in addition to their component API.

Parameters:

value - whether the buffer should be on or not.

See Also:

getPowerState()

getPowerState

boolean getPowerState()

Get the current power state.

Returns:

whether the buffer is powered on.

See Also:

setPowerState(boolean)

setMaximumResolution

void setMaximumResolution(int width,
                        int height)

Sets the maximum resolution supported by this buffer.

Parameters:

width - the maximum horizontal resolution, in characters.

height - the maximum vertical resolution, in characters.

getMaximumWidth

int getMaximumWidth()

Get the maximum horizontal size of the buffer.

getMaximumHeight

int getMaximumHeight()

Get the maximum vertical size of the buffer.

setAspectRatio

void setAspectRatio(double width,
                  double height)

Set the 'aspect ratio' of the buffer.

Not to be confused with the maximum resolution of the buffer, this refers to the 'physical' size of the buffer's container. For multi- block screens, for example, this is the number of horizontal and vertical blocks.

Parameters:

width - the horizontal size of the physical representation.

height - the vertical size of the physical representation.

getAspectRatio

double getAspectRatio()

Get the aspect ratio of the buffer.

Note that this is in fact width / height.

See Also:

setAspectRatio(double, double)

setResolution

boolean setResolution(int width,
                    int height)

Set the buffer's active resolution.

Parameters:

width - the horizontal resolution.

height - the vertical resolution.

Returns:

true if the resolution changed.

getWidth

int getWidth()

Get the current horizontal resolution.

See Also:

setResolution(int, int)

getHeight

int getHeight()

Get the current vertical resolution.

See Also:

setResolution(int, int)

setMaximumColorDepth

void setMaximumColorDepth(TextBuffer.ColorDepth depth)

Sets the maximum color depth supported by this buffer.

Note that this is the maximum supported depth, lower depths will be supported, too. So when setting this to four bit, one bit will be supported, too. When setting this to eight bit, four and one bit will be supported, also.

Parameters:

depth - the maximum color depth of the buffer.

getMaximumColorDepth

TextBuffer.ColorDepth getMaximumColorDepth()

Get the maximum color depth supported.

setColorDepth

boolean setColorDepth(TextBuffer.ColorDepth depth)

Set the active color depth for this buffer.

Parameters:

depth - the new color depth.

Returns:

true if the color depth changed.

getColorDepth

TextBuffer.ColorDepth getColorDepth()

Get the active color depth of this buffer.

setPaletteColor

void setPaletteColor(int index,
                   int color)

Set the color of the active color palette at the specified index.

This will error if the current depth does not have a palette (one bit).

Parameters:

index - the index at which to set the color.

color - the color to set for the specified index.

getPaletteColor

int getPaletteColor(int index)

Get the color in the active color palette at the specified index.

This will error if the current depth does not have a palette (one bit).

Parameters:

index - the index at which to get the color.

Returns:

the color in the active palette at the specified index.

setForegroundColor

void setForegroundColor(int color)

Set the active foreground color, not using a palette.

Parameters:

color - the new foreground color.

See Also:

setForegroundColor(int, boolean)

setForegroundColor

void setForegroundColor(int color,
                      boolean isFromPalette)

Set the active foreground color.

If the value is not from the palette, the actually stored value may differ from the specified one, as it is converted to the buffer's current color depth.

For palette-only color formats (four bit) the best fit from the palette is chosen, if the value is not from the palette.

Parameters:

color - the color or palette index.

isFromPalette - trueif color specifies a palette index.

getForegroundColor

int getForegroundColor()

The active foreground color.

isForegroundFromPalette

boolean isForegroundFromPalette()

true if the foreground color is from the color palette, meaning the value returned from getForegroundColor() is the color palette index.

setBackgroundColor

void setBackgroundColor(int color)

Set the active background color, not using a palette.

Parameters:

color - the new background color.

See Also:

setBackgroundColor(int, boolean)

setBackgroundColor

void setBackgroundColor(int color,
                      boolean isFromPalette)

Set the active background color.

If the value is not from the palette, the actually stored value may differ from the specified one, as it is converted to the buffer's current color depth.

For palette-only color formats (four bit) the best fit from the palette is chosen, if the value is not from the palette.

Parameters:

color - the color or palette index.

isFromPalette - trueif color specifies a palette index.

getBackgroundColor

int getBackgroundColor()

The active background color.

isBackgroundFromPalette

boolean isBackgroundFromPalette()

true if the background color is from the color palette, meaning the value returned from getBackgroundColor() is the color palette index.

copy

void copy(int column,
        int row,
        int width,
        int height,
        int horizontalTranslation,
        int verticalTranslation)

Copy a portion of the text buffer.

This will copy the area's text and colors.

Parameters:

column - the starting horizontal index of the area to copy.

row - the starting vertical index of the area to copy.

width - the width of the area to copy.

height - the height of the area to copy.

horizontalTranslation - the horizontal offset, relative to the starting column to copy the are to.

verticalTranslation - the vertical offset, relative to the starting row to copy the are to.

fill

void fill(int column,
        int row,
        int width,
        int height,
        char value)

Fill a portion of the text buffer.

This will set the area's colors to the currently active ones.

Parameters:

column - the starting horizontal index of the area to fill.

row - the starting vertical index of the area to fill.

width - the width of the area to fill.

height - the height of the area to fill.

value - the character to fill the area with.

set

void set(int column,
       int row,
       java.lang.String value,
       boolean vertical)

Write a string into the text buffer.

This will apply the currently active colors to the changed area.

Parameters:

column - the starting horizontal index to write at.

row - the starting vertical index to write at.

value - the string to write.

vertical - true if the string should be written vertically instead of horizontally.

get

char get(int column,
       int row)

Get the character in the text buffer at the specified location.

Parameters:

column - the horizontal index.

row - the vertical index.

Returns:

the character at that index.

getForegroundColor

int getForegroundColor(int column,
                     int row)

Get the foreground color of the text buffer at the specified location.

Important: this may be a palette index.

Parameters:

column - the horizontal index.

row - the vertical index.

Returns:

the foreground color at that index.

isForegroundFromPalette

boolean isForegroundFromPalette(int column,
                              int row)

Whether the foreground color of the text buffer at the specified location if from the color palette.

Parameters:

column - the horizontal index.

row - the vertical index.

Returns:

whether the foreground at that index is from the palette.

getBackgroundColor

int getBackgroundColor(int column,
                     int row)

Get the background color of the text buffer at the specified location.

Important: this may be a palette index.

Parameters:

column - the horizontal index.

row - the vertical index.

Returns:

the background color at that index.

isBackgroundFromPalette

boolean isBackgroundFromPalette(int column,
                              int row)

Whether the background color of the text buffer at the specified location if from the color palette.

Parameters:

column - the horizontal index.

row - the vertical index.

Returns:

whether the background at that index is from the palette.

renderText

boolean renderText()

Renders the text displayed on the buffer.

You are responsible for setting up the actual context and applying any transformations necessary to properly position and scale the text before calling this. The text should be rendered on a black background.

You can use this to either render the text in a GUI or in the world.

Returns:

true if the displayed content changed since the last call to this method.

renderWidth

int renderWidth()

The natural width of the rendered text.

This is the width of the complete text buffer, in pixels. In other words, this is the width of the buffer in chars times the actual width of a single char in pixels.

Returns:

the total width of the rendered buffer, in pixels.

renderHeight

int renderHeight()

The natural height of the rendered text.

This is the height of the complete text buffer, in pixels. In other words, this is the height of the buffer in chars times the actual height of a single char in pixels.

Returns:

the total height of the rendered buffer, in pixels.

setRenderingEnabled

void setRenderingEnabled(boolean enabled)

Set whether the contents of the buffer should currently be rendered.

Note that this is automatically overwritten when the buffer's power state changes, i.e. when it runs out of power or gets back power.

Parameters:

enabled - whether the text buffer should be rendered.

isRenderingEnabled

boolean isRenderingEnabled()

Gets whether the contents of the buffer should currently be rendered.

See Also:

setRenderingEnabled(boolean)

keyDown

void keyDown(char character,
           int code,
           net.minecraft.entity.player.EntityPlayer player)

Signals a key down event for the buffer.

On the client side this causes a packet to be sent to the server. On the server side this will trigger a message that will be picked up by keyboards, which will then cause a signal in attached machines.

Parameters:

character - the character of the pressed key.

code - the key code of the pressed key.

player - the player that pressed the key. Pass null on the client side.

keyUp

void keyUp(char character,
         int code,
         net.minecraft.entity.player.EntityPlayer player)

Signals a key up event for the buffer.

On the client side this causes a packet to be sent to the server. On the server side this will trigger a message that will be picked up by keyboards, which will then cause a signal in attached machines.

Parameters:

character - the character of the released key.

code - the key code of the released key.

player - the player that released the key. Pass null on the client side.

clipboard

void clipboard(java.lang.String value,
             net.minecraft.entity.player.EntityPlayer player)

Signals a clipboard paste event for the buffer.

On the client side this causes a packet to be sent to the server. On the server side this will trigger a message that will be picked up by keyboards, which will then cause a signal in attached machines.

Parameters:

value - the text that was pasted.

player - the player that pasted the text. Pass null on the client side.

mouseDown

void mouseDown(int x,
             int y,
             int button,
             net.minecraft.entity.player.EntityPlayer player)

Signals a mouse button down event for the buffer.

On the client side this causes a packet to be sent to the server. On the server side this will cause a signal in attached machines.

Parameters:

x - the horizontal coordinate of the mouse, in characters.

y - the vertical coordinate of the mouse, in characters.

button - the button of the mouse that was pressed.

player - the player that pressed the mouse button. Pass null on the client side.

mouseDrag

void mouseDrag(int x,
             int y,
             int button,
             net.minecraft.entity.player.EntityPlayer player)

Signals a mouse drag event for the buffer.

On the client side this causes a packet to be sent to the server. On the server side this will cause a signal in attached machines.

Parameters:

x - the horizontal coordinate of the mouse, in characters.

y - the vertical coordinate of the mouse, in characters.

button - the button of the mouse that is pressed.

player - the player that moved the mouse. Pass null on the client side.

mouseUp

void mouseUp(int x,
           int y,
           int button,
           net.minecraft.entity.player.EntityPlayer player)

Signals a mouse button release event for the buffer.

On the client side this causes a packet to be sent to the server. On the server side this will cause a signal in attached machines.

Parameters:

x - the horizontal coordinate of the mouse, in characters.

y - the vertical coordinate of the mouse, in characters.

button - the button of the mouse that was released.

player - the player that released the mouse button. Pass null on the client side.

mouseScroll

void mouseScroll(int x,
               int y,
               int delta,
               net.minecraft.entity.player.EntityPlayer player)

Signals a mouse wheel scroll event for the buffer.

On the client side this causes a packet to be sent to the server. On the server side this will cause a signal in attached machines.

Parameters:

x - the horizontal coordinate of the mouse, in characters.

y - the vertical coordinate of the mouse, in characters.

delta - indicates the direction of the mouse scroll.

player - the player that scrolled the mouse wheel. Pass null on the client side.