Skip to main content

Screen

Struct Screen 

Source
pub struct Screen(pub Address);
Expand description

The screen component (9 methods).

Provided by OpenComputers’ Screen, TextBuffer, TextBufferBase.

Tuple Fields§

§0: Address

Implementations§

Source§

impl Screen

Source

pub fn get_aspect_ratio(&self) -> Result<(Number, Number)>

The aspect ratio of the screen. For multi-block screens this is the number of blocks, horizontal and vertical.

Lua: screen.getAspectRatio():number, number Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn get_aspect_ratio_async(&self) -> Result<(Number, Number)>

Self::get_aspect_ratio without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn get_keyboards(&self) -> Result<Value>

The list of keyboards attached to the screen.

Lua: screen.getKeyboards():table Indirect call: waits for the next server tick.

Source

pub async fn get_keyboards_async(&self) -> Result<Value>

Self::get_keyboards without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn is_on(&self) -> Result<bool>

Returns whether the screen is currently on.

Lua: screen.isOn():boolean Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn is_on_async(&self) -> Result<bool>

Self::is_on without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn is_precise(&self) -> Result<bool>

Returns whether the screen is in high precision mode (sub-pixel mouse event positions).

Lua: screen.isPrecise():boolean Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn is_precise_async(&self) -> Result<bool>

Self::is_precise without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn is_touch_mode_inverted(&self) -> Result<bool>

Whether touch mode is inverted (sneak-activate opens GUI, instead of normal activate).

Lua: screen.isTouchModeInverted():boolean Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn is_touch_mode_inverted_async(&self) -> Result<bool>

Self::is_touch_mode_inverted without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn set_precise(&self, enabled: bool) -> Result<bool>

Set whether to use high precision mode (sub-pixel mouse event positions).

Lua: screen.setPrecise(enabled:boolean):boolean Indirect call: waits for the next server tick.

Source

pub async fn set_precise_async(&self, enabled: bool) -> Result<bool>

Self::set_precise without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn set_touch_mode_inverted(&self, value: bool) -> Result<bool>

Sets whether to invert touch mode (sneak-activate opens GUI, instead of normal activate).

Lua: screen.setTouchModeInverted(value:boolean):boolean Indirect call: waits for the next server tick.

Source

pub async fn set_touch_mode_inverted_async(&self, value: bool) -> Result<bool>

Self::set_touch_mode_inverted without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn turn_off(&self) -> Result<bool>

Turns the screen off. Returns whether the state changed, and whether it is now on.

Lua: screen.turnOff():boolean Indirect call: waits for the next server tick.

Source

pub async fn turn_off_async(&self) -> Result<bool>

Self::turn_off without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn turn_on(&self) -> Result<bool>

Turns the screen on. Returns whether the state changed, and whether it is now on.

Lua: screen.turnOn():boolean Indirect call: waits for the next server tick.

Source

pub async fn turn_on_async(&self) -> Result<bool>

Self::turn_on without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Trait Implementations§

Source§

impl Clone for Screen

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Component for Screen

Source§

const KIND: &'static str = "screen"

The OpenComputers component type, such as "gpu".
Source§

fn from_address(address: Address) -> Self

Wraps an address without checking what is there.
Source§

fn address(&self) -> &Address

Source§

fn first() -> Option<Self>

The first component of this type, by address order.
Source§

fn all() -> Vec<Self>

Every component of this type, by address order.
Source§

fn at(address: impl Into<Address>) -> Option<Self>

The component at address, if it is of this type.
Source§

fn invoke(&self, method: &str, args: Vec<Value>) -> Result<Vec<Value>>

An untyped call, for methods the wrapper doesn’t know.
Source§

fn invoke_async(&self, method: &str, args: Vec<Value>) -> Call ⓘ

Component::invoke without blocking; see invoke_async.
Source§

impl Debug for Screen

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for Screen

Source§

impl Hash for Screen

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Screen

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Screen

Auto Trait Implementations§

§

impl Forget for Screen

§

impl Freeze for Screen

§

impl Move for Screen

§

impl RefUnwindSafe for Screen

§

impl Send for Screen

§

impl Sync for Screen

§

impl Unpin for Screen

§

impl UnsafeUnpin for Screen

§

impl UnwindSafe for Screen

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.