Skip to main content

Type

Enum Type 

Source
pub enum Type {
Show 104 variants Int, Boolean, String, Long, Char, Colour, Coord, Loc, Npc, Obj, NamedObj, PlayerUid, NpcUid, Seq, Spotanim, Synth, Vorbis, Midi, Jingle, Graphic, FontMetrics, ChatCat, ChatPhrase, Model, Texture, IdKit, MesAnim, Hitmark, Stat, Component, IfType, SetPosH, SetPosV, SetSize, SetTextAlignH, SetTextAlignV, ClanForumQfc, IntArray, Key, ChatType, ChatFilter, WindowMode, PlatformType, IntBool, Interface, TopLevelInterface, OverlayInterface, Inv, Enum, Struct, Param, DbTable, DbRow, DbColumn, Category, Varp, Varn, Vars, VarpBit, Varc, VarClan, VarClanSetting, VarCon, VarConBit, VarnBit, VarObj, MapZone, MapArea, MapElement, LocShape, NpcMode, NpcStat, Area, Hunt, MoveSpeed, EntityOverlay, StringVector, WriteInv, Bas, Billboard, ParticleEffector, ParticleEmitter, Cursor, Flo, Flu, ItemCode, Light, Msi, Quest, Controller, RegionCoord, RegionUid, Proc, ClientScript, Label, Queue, SoftTimer, Timer, Walktrigger, ControllerQueue, NpcQueue, Any, Error, Void,
}
Expand description

All script variable types supported by RuneScript. These correspond to the types used in the 2004Scape/RS2 engine.

Variants§

§

Int

§

Boolean

§

String

§

Long

§

Char

§

Colour

§

Coord

§

Loc

§

Npc

§

Obj

§

NamedObj

§

PlayerUid

§

NpcUid

§

Seq

§

Spotanim

§

Synth

§

Vorbis

§

Midi

§

Jingle

§

Graphic

§

FontMetrics

§

ChatCat

§

ChatPhrase

§

Model

§

Texture

§

IdKit

§

MesAnim

§

Hitmark

§

Stat

§

Component

§

IfType

§

SetPosH

§

SetPosV

§

SetSize

§

SetTextAlignH

§

SetTextAlignV

§

ClanForumQfc

§

IntArray

A parameter holding the number of one of the caller’s arrays.

§

Key

§

ChatType

§

ChatFilter

§

WindowMode

§

PlatformType

§

IntBool

§

Interface

§

TopLevelInterface

§

OverlayInterface

§

Inv

§

Enum

§

Struct

§

Param

§

DbTable

§

DbRow

§

DbColumn

§

Category

§

Varp

§

Varn

§

Vars

§

VarpBit

§

Varc

§

VarClan

§

VarClanSetting

§

VarCon

§

VarConBit

§

VarnBit

§

VarObj

§

MapZone

§

MapArea

§

MapElement

§

LocShape

§

NpcMode

§

NpcStat

§

Area

§

Hunt

§

MoveSpeed

§

EntityOverlay

§

StringVector

§

WriteInv

§

Bas

§

Billboard

§

ParticleEffector

§

ParticleEmitter

§

Cursor

§

Flo

§

Flu

§

ItemCode

§

Light

§

Msi

§

Quest

§

Controller

§

RegionCoord

§

RegionUid

A region (instance), as region_uid gives it and region_findbyuid takes it.

§

Proc

§

ClientScript

§

Label

§

Queue

§

SoftTimer

§

Timer

§

Walktrigger

§

ControllerQueue

§

NpcQueue

§

Any

§

Error

§

Void

Implementations§

Source§

impl Type

Source

pub const CHARS: &'static str = "is§1clnoOpNAtPMjdmxKSIavgJyVÐþ`µzf«ke@\u{80}"

Every character a script names a type by.

Source

pub fn to_char(self) -> char

Source

pub fn from_char(ch: char) -> Option<Self>

Source

pub fn base_type(&self) -> BaseVarType

Returns the base var type (determines which stack to use).

Source

pub fn default_int_value(&self) -> i32

Default value for uninitialised local variable declarations. Boolean and Int default to 0; all other int-based types default to -1 (null).

Source

pub fn default_return_value(&self) -> i32

Default value for implicit return values at end of scripts. Only Int pushes 0; everything else (including Boolean) pushes -1.

Source

pub fn from_def_str(s: &str) -> Option<Type>

Parse a type name from a def_ prefix (e.g., “def_int” -> Int).

Source

pub fn from_name(s: &str) -> Option<Type>

Parse a type from its bare name (e.g., “int” -> Int).

Source

pub fn is_int_kind(&self) -> bool

An int that only differs in how its values print: declarations say int.

Source

pub fn declared_name(&self) -> &'static str

The name a declaration of this type gives.

Source

pub fn name(&self) -> &'static str

Get the name of this type as used in RuneScript source.

Source

pub fn allow_switch(&self) -> bool

Source

pub fn is_numeric(&self) -> bool

Returns true if this is a numeric type that supports arithmetic.

Source

pub fn is_obj_type(&self) -> bool

Returns true if this is a type that uses object-style comparison (string equality).

Source

pub fn all_def_keywords() -> Vec<&'static str>

Returns all known def_ type names.

Trait Implementations§

Source§

impl Clone for Type

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 Copy for Type

Source§

impl Debug for Type

Source§

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

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

impl Display for Type

Source§

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

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

impl Eq for Type

Source§

impl Hash for Type

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 Type

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 Type

Auto Trait Implementations§

§

impl Forget for Type

§

impl Freeze for Type

§

impl Move for Type

§

impl RefUnwindSafe for Type

§

impl Send for Type

§

impl Sync for Type

§

impl Unpin for Type

§

impl UnsafeUnpin for Type

§

impl UnwindSafe for Type

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more