Struct World

pub struct World {
    pub discriminator: [u8; 8],
    pub name: String,
    pub description: String,
    pub entities: Vec<Entity>,
    pub regions: Vec<Region>,
    pub instances: BTreeMap<Region, BTreeMap<Entity, u64>>,
    pub is_launched: bool,
    pub world_authority: Pubkey,
    pub bump: u8,
}

Fields

discriminator: [u8; 8]

Identifier for this specific structure

name: String

Description of the world

description: String

Description of the world

entities: Vec<Entity>

Onchain record of what Entity types exist in the world

regions: Vec<Region>

Onchain record of what Regions exist in the world

instances: BTreeMap<Region, BTreeMap<Entity, u64>>

Source of truth for what Instances exist in the world

is_launched: bool

Determines if the World is already launched and instances can now be Created, Updated, and Deleted outside of the CreateWorld (Initialization) Instruction

world_authority: Pubkey

Overaching authority who has access to state changing operations

bump: u8

Canonical bump for World

Implementations

impl World

pub fn is_initialized(&self) -> bool

Is true if World is initialized

pub fn is_uninitialized(&self) -> bool

Is true if World is uninitialized

pub fn new( name: String, description: String, world_authority: Pubkey, regions: Vec<Region>, entities: Vec<Entity>, bump: u8, preload: bool, ) -> Self

Create new World state

Arguments

• name - A String that holds the name of the world
• description - A String that holds the description of the world
• world_authority - A Pubkey of the authority who can change the world’s account data
• regions - A Vector of the new type Region holding all the existing regions in the world
• entities - A Vector of the new type Entity holding all the existing entities in the world
• bump - A u8 holding the canonical bump of the World’s onchain account used for PDA derivation
• preload - A bool that allows preloading of BTreeMap keys in the World instances property

Trait Implementations

impl BorshDeserialize for World

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for World

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for World

fn clone(&self) -> World

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for World

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

Formats the value using the given formatter.

impl Default for World

fn default() -> World

Returns the “default value” for a type.

impl PartialEq for World

fn eq(&self, other: &World) -> 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 SplDiscriminate for World

const SPL_DISCRIMINATOR: ArrayDiscriminator

The 8-byte discriminator as a [u8; 8]

const SPL_DISCRIMINATOR_SLICE: &'static [u8] = _

The 8-byte discriminator as a slice (&[u8])

impl Eq for World

impl StructuralPartialEq for World