Struct CodeIcon 

pub struct CodeIcon {

    pub name: String,
    pub material: String,
    pub advanced: Option<bool>,
    pub description: Vec<String>,
    pub example: Vec<String>,
    pub works_with: Vec<String>,
    pub deprecated_note: Vec<String>,
    pub additional_info: Vec<Vec<String>>,
    pub arguments: Option<Vec<Argument>>,
    pub return_type: Option<String>,
    pub return_description: Option<Vec<String>>,
    pub required_rank: String,
    pub require_tokens: bool,
    pub require_rank_and_tokens: bool,
    pub mobs_only: Option<bool>,
    pub cancellable: Option<bool>,
    pub cancelled_automatically: Option<bool>,
    pub head: Option<String>,
    pub color: Option<IconColor>,
    pub tags: Option<u8>,
    pub loaded_item: Option<String>,
}

The display information for a CodeData.

Fields

name: String

The display name of this code item.

material: String

The item material.

This is a bukkit material name

advanced: Option<bool>

Whether this code item is considered advanced.

description: Vec<String>

A description of this code item.

example: Vec<String>

An example of the usage of this code item.

works_with: Vec<String>

Things that this code item works on/with.

deprecated_note: Vec<String>

Information about the deprecation of this code item.

additional_info: Vec<Vec<String>>

Any additional information about this code item.

arguments: Option<Vec<Argument>>

return_type: Option<String>

The return type of this game value.

return_description: Option<Vec<String>>

The description for the returned value.

required_rank: String

The rank required to use this code item.

require_tokens: bool

Whether this code item requires a purchase in the token shop to use.

require_rank_and_tokens: bool

Supposedly true when the following conditions are met:

1. required_rank is not empty
2. require_tokens is true

Seems to be broken and always false.

mobs_only: Option<bool>

Whether this action can only be used on mobs.

cancellable: Option<bool>

Whether this event can be cancelled.

cancelled_automatically: Option<bool>

Whether this event is automatically cancelled.

head: Option<String>

The texture data for the item if the material is PLAYER_HEAD.

color: Option<IconColor>

The color data for the item.

tags: Option<u8>

A boolean encoded as 0 or 1 denoting whether this action has any tags.

loaded_item: Option<String>

Unknown.

Always an empty String.

Implementations

impl CodeIcon

pub fn is_legacy(&self) -> bool

Returns whether this code item is considered legacy.

This is determined by testing if the material is STONE

pub fn is_deprecated(&self) -> bool

Returns whether this code item is deprecated.

This is determined by whether the deprecated note is not empty

Trait Implementations

impl Clone for CodeIcon

fn clone(&self) -> CodeIcon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeIcon

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CodeIcon

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CodeIcon

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CodeIcon

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CodeIcon

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CodeIcon

impl StructuralPartialEq for CodeIcon