Struct df_st_core::df_world::region::Region

pub struct Region {
    pub id: i32,
    pub name: Option<String>,
    pub type_: Option<String>,
    pub coords: Vec<Coordinate>,
    pub evilness: Option<String>,
    pub force_id: Vec<i32>,
}

A Region is a section of map that has specific properties. These regions are usually described by natural features likes forest, oceans or lakes. Every region tile should be in at least one Region. Sites are thus always in at least one Region.

Fields

id: i32

Identifier for the region. id must be unique for the whole world.

name: Option<String>

Name of the region. name is in all lowercase.

type_: Option<String>

Defines what biome or natural feature the region is. Example: "Forest", "Lake", "Tundra",...

coords: Vec<Coordinate>

A list of coordinates for each square that is covered by this region More info can be found in Coordinate

evilness: Option<String>

Defines if the region is good, neutral or evil.

force_id: Vec<i32>

From DFHacK: historical figure IDs of force deities associated with the region. Number set increases during civ placement.

Implementations

impl Region

pub fn new() -> Self

Trait Implementations

impl Clone for Region

fn clone(&self) -> Region

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Region

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

Formats the value using the given formatter.

impl Default for Region

fn default() -> Region

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Region

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Fillable for Region

impl Filler<Region, Region> for Region

fn add_missing_data(&mut self, source: &Region)

Add data to self that is set as None or appends list items. Use source object to get values from.

fn never_replace_data(&mut self, source: &Region)

Add data to self that is set as None or appends list items. If a value is Some it will leave the value as is.

fn replace_data(&mut self, source: &Region)

Add data to self. If already some value present, replace it. Appends list items. This is used when there is data that is richer then previous data. It does not trow the not_same_data warning. add_missing_data should be used in most cases instead.

fn add_missing_data_indexed(&mut self, source: &S, _index: u64)

Add data to self from source. Same ways as add_missing_data. This function is used when adding data when looping over lists. This allows the index to be used. For example as an incremental ID. This function can be overwritten if this ID is wanted.

fn check_mergeable(&self, source: &S) -> bool where
    Self: Debug + Default + PartialEq<Self>,
    S: PartialEq<Self> + Debug, 

impl<__S> GraphQLType<__S> for Region where
    __S: ScalarValue,
    &'__b __S: ScalarRefValue<'__b>, 

type Context = ()

The expected context type for this GraphQL type

type TypeInfo = ()

Type that may carry additional schema information

fn name(_: &Self::TypeInfo) -> Option<&str>

The name of the GraphQL type to expose.

fn meta<'r>(
    info: &Self::TypeInfo,
    registry: &mut Registry<'r, __S>
) -> MetaType<'r, __S> where
    __S: 'r,
    &'z __S: ScalarRefValue<'z>, 

The meta type representing this GraphQL type.

fn resolve_field(
    &self,
    _info: &(),
    field: &str,
    args: &Arguments<'_, __S>,
    executor: &Executor<'_, Self::Context, __S>
) -> ExecutionResult<__S>

Resolve the value of a single field on this type.

fn concrete_type_name(&self, _: &Self::Context, _: &Self::TypeInfo) -> String

Return the concrete type name for this instance/union.

fn resolve_into_type(
    &self,
    info: &Self::TypeInfo,
    type_name: &str,
    selection_set: Option<&[Selection<'_, S>]>,
    executor: &Executor<'_, Self::Context, S>
) -> Result<Value<S>, FieldError<S>>

Resolve this interface or union into a concrete type

fn resolve(
    &self,
    info: &Self::TypeInfo,
    selection_set: Option<&[Selection<'_, S>]>,
    executor: &Executor<'_, Self::Context, S>
) -> Value<S>

Resolve the provided selection set against the current object.

impl Hash for Region

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, 

Feeds a slice of this type into the given [Hasher].

impl JsonSchema for Region

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq<Region> for Region

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl SchemaExample for Region

fn example() -> Self

impl Serialize for Region

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

Serialize this value into the given Serde serializer.