Enum Item

Source

#[non_exhaustive]pub enum Item {
Show 422 variants    Accessory,
    AccessoryTag,
    AccessoryVariation,
    AccessoryVariationLayout,
    AccessoryVariationTextures,
    Achievement,
    AchievementGroup,
    Asset,
    BlendShape,
    CharacterInteraction,
    Coa,
    CoaColorList,
    CoaColoredEmblemList,
    CoaDesignerColorPalette,
    CoaDesignerColoredEmblem,
    CoaDesignerEmblemLayout,
    CoaDesignerPattern,
    CoaPatternList,
    CoaTemplate,
    CoaTemplateList,
    CoaTexturedEmblemList,
    Culture,
    CustomLocalization,
    Decision,
    Define,
    Directory,
    Dlc,
    DlcFeature,
    DlcName,
    EffectLocalization,
    Entity,
    Entry,
    Ethnicity,
    Event,
    EventNamespace,
    File,
    Font,
    Fontfiles,
    GameConcept,
    GameRule,
    GameRuleSetting,
    GeneAgePreset,
    GeneAttribute,
    GeneCategory,
    GovernmentType,
    GuiLayer,
    GuiTemplate,
    GuiType,
    LawGroup,
    Localization,
    MapEnvironment,
    MapMode,
    Modifier,
    Music,
    MusicPlayerCategory,
    NamedColor,
    OnAction,
    Pdxmesh,
    PortraitAnimation,
    PortraitCamera,
    PortraitEnvironment,
    PortraitModifierGroup,
    PortraitModifierPack,
    Province,
    Religion,
    ScriptedEffect,
    ScriptedGui,
    ScriptedList,
    ScriptedModifier,
    ScriptedRule,
    ScriptedTrigger,
    ScriptValue,
    Shortcut,
    Sound,
    Terrain,
    TextFormat,
    TextIcon,
    TextureFile,
    TriggerLocalization,
    WidgetName,
    Building,
    CharacterTemplate,
    CharacterTrait,
    Country,
    DeathReason,
    Dna,
    EventTheme,
    Law,
    Message,
    PopType,
    Region,
    SubjectType,
    TutorialLesson,
    TutorialLessonChain,
    TutorialLessonStep,
    Wargoal,
    AccoladeCategory,
    AccoladeIcon,
    AccoladeName,
    AccoladeParameter,
    AccoladeType,
    ActivityIntent,
    ActivityLocale,
    ActivityOption,
    ActivityOptionCategory,
    ActivityPhase,
    ActivityPulseAction,
    ActivityState,
    ActivityType,
    AiWarStance,
    AgentType,
    Amenity,
    AmenitySetting,
    ArtifactBlueprint,
    ArtifactFeature,
    ArtifactFeatureGroup,
    ArtifactHistory,
    ArtifactRarity,
    ArtifactSlot,
    ArtifactSlotType,
    ArtifactTemplate,
    ArtifactType,
    ArtifactVisual,
    Bookmark,
    BookmarkGroup,
    BookmarkPortrait,
    BuildingFlag,
    BuildingGfx,
    CasusBelli,
    CasusBelliGroup,
    Catalyst,
    ChallengeCharacter,
    Character,
    CharacterBackground,
    CharacterInteractionCategory,
    Climate,
    ClothingGfx,
    CoaGfx,
    CoaDynamicDefinition,
    CombatEffect,
    CombatPhaseEvent,
    CouncilPosition,
    CouncilTask,
    Countermeasure,
    CountermeasureParameter,
    CourtPosition,
    CourtPositionCategory,
    CourtSceneCulture,
    CourtSceneGroup,
    CourtSceneRole,
    CourtSceneSetting,
    CourtType,
    CourtierGuestManagement,
    CultureAesthetic,
    CultureCreationName,
    CultureEra,
    CultureEthos,
    CultureHeritage,
    CultureHistory,
    CultureParameter,
    CulturePillar,
    CultureTradition,
    CultureTraditionCategory,
    DangerType,
    DecisionGroup,
    DiarchyMandate,
    DiarchyParameter,
    DiarchyType,
    Doctrine,
    DoctrineCategory,
    DoctrineParameter,
    DomicileBuilding,
    DomicileParameter,
    DomicileType,
    Dynasty,
    DynastyLegacy,
    DynastyPerk,
    EpidemicType,
    EpidemicDeathReason,
    EventBackground,
    EventEffect2d,
    EventTransition,
    Faction,
    Faith,
    FaithIcon,
    FervorModifier,
    Flavorization,
    Focus,
    GeneticConstraint,
    GovernmentFlag,
    GraphicalFaith,
    GuestInviteRule,
    GuestSubset,
    GuestSystem,
    HoldingFlag,
    HoldingType,
    HolySite,
    HolySiteFlag,
    Hook,
    House,
    HousePowerBonus,
    HouseUnity,
    HouseUnityParameter,
    HouseUnityStage,
    ImportantAction,
    Innovation,
    InnovationFlag,
    Inspiration,
    Language,
    LawFlag,
    LeaseContract,
    LegendChapter,
    LegendChronicle,
    LegendProperty,
    LegendSeed,
    LegendType,
    LegitimacyFlag,
    LegitimacyType,
    Lifestyle,
    MartialCustom,
    MemoryCategory,
    MemoryType,
    MenAtArms,
    MenAtArmsBase,
    MessageFilterType,
    MessageGroupType,
    ModifierFormat,
    MottoInsert,
    Motto,
    NameEquivalency,
    NameList,
    Nickname,
    OpinionModifier,
    Perk,
    PerkTree,
    PlayableDifficultyInfo,
    PointOfInterest,
    PoolSelector,
    PortraitType,
    PrisonType,
    ProvinceMapping,
    Relation,
    RelationFlag,
    ReligionFamily,
    RewardItem,
    Scheme,
    SchemePulseAction,
    ScriptedAnimation,
    ScriptedCost,
    ScriptedIllustration,
    Secret,
    Sexuality,
    Skill,
    SpecialBuilding,
    SpecialGuest,
    Story,
    Struggle,
    StruggleHistory,
    StrugglePhase,
    StrugglePhaseParameter,
    SuccessionAppointment,
    SuccessionElection,
    Suggestion,
    TaskContractGroup,
    TaskContractReward,
    TaskContractType,
    TaxSlotFlag,
    TaxSlotObligation,
    TaxSlotType,
    Title,
    TitleHistory,
    TitleHistoryType,
    Trait,
    TraitCategory,
    TraitFlag,
    TraitPortraitModifier,
    TraitTrack,
    TravelOption,
    UnitGfx,
    VassalContract,
    VassalContractFlag,
    VassalObligationLevel,
    VassalStance,
    AcceptanceStatus,
    AiStrategy,
    Alert,
    AlertGroup,
    Approval,
    Attitude,
    BattleCondition,
    BuildingGroup,
    BuildingType,
    BuyPackage,
    CanalType,
    CharacterRole,
    CombatUnit,
    CombatUnitExperienceLevel,
    CombatUnitGroup,
    CommanderOrder,
    CommanderRank,
    CompanyType,
    CohesionLevel,
    CountryCreation,
    CountryFormation,
    CountryRank,
    CountryTier,
    CountryType,
    CultureGraphics,
    Decree,
    DiplomaticAction,
    DiplomaticCatalyst,
    DiplomaticCatalystCategory,
    DiplomaticPlay,
    DiscriminationTrait,
    DynamicCompanyName,
    DynamicCountryMapColor,
    DynamicCountryName,
    EventCategory,
    FlagDefinition,
    Goods,
    GradientBorderSettings,
    HarvestConditionType,
    Ideology,
    InfamyThreshold,
    Institution,
    InterestGroup,
    InterestGroupTrait,
    JournalEntry,
    JournalEntryGroup,
    LawType,
    LegitimacyLevel,
    Level,
    LibertyDesireLevel,
    MapLayer,
    MapInteractionType,
    MapNotificationType,
    MediaAlias,
    MilitaryFormationFlag,
    MobilizationOption,
    MobilizationOptionGroup,
    ModifierTypeDefinition,
    Objective,
    ObjectiveSubgoal,
    ObjectiveSubgoalCategory,
    Party,
    PoliticalLobby,
    PoliticalLobbyAppeasement,
    PoliticalMovement,
    PoliticalMovementCategory,
    PoliticalMovementPopSupport,
    PopNeed,
    PowerBlocCoaPiece,
    PowerBlocIdentity,
    PowerBlocMapTexture,
    PowerBlocName,
    Principle,
    PrincipleGroup,
    ProductionMethod,
    ProductionMethodGroup,
    ProposalType,
    RelationsThreshold,
    ScriptedButton,
    ScriptedProgressBar,
    ScriptedTest,
    SecretGoal,
    SocialClass,
    SocialHierarchy,
    StateRegion,
    StateTrait,
    Strata,
    StrategicRegion,
    Technology,
    TechnologyEra,
    TerrainKey,
    TerrainLabel,
    TerrainManipulator,
    TerrainMask,
    TerrainMaterial,
    TransferOfPower,
    Ambition,
    AiPlanGoals,
    Area,
    CultureGroup,
    CombatTactic,
    Deity,
    DeityCategory,
    DiplomaticStance,
    EconomicPolicy,
    EventPicture,
    GovernorPolicy,
    GraphicalCultureType,
    GreatWorkEffectTier,
    GreatWorkEffect,
    GreatWorkCategory,
    GreatWorkMaterial,
    GreatWorkModule,
    GreatWorkTemplate,
    Heritage,
    Idea,
    Invention,
    InventionGroup,
    LegionDistinction,
    LevyTemplate,
    Loyalty,
    MilitaryTraditionTree,
    MilitaryTradition,
    Mission,
    MissionTask,
    Office,
    Opinion,
    PartyAgenda,
    PartyType,
    PostSetupCharacters,
    Price,
    ProvinceRank,
    SetupCharacters,
    SetupProvinces,
    TechnologyTable,
    TradeGood,
    Treasure,
    Unit,
    UnitAbility,
}

Expand description

“items” are all the things that can be looked up in the game databases. Anything that can be looked up in script with a literal string key, or that’s loaded into tiger’s database and needs a unique key, is an Item.

There is some overlap with scopes, for example “culture” is both an Item and a scope type, but the difference is that scopes are runtime values while items are always strings.

For example if a trigger takes a culture scope, you could supply either culture:german or scope:target_culture, while if a trigger takes a culture item, you would have to supply just german and don’t have the option of supplying something determined at runtime.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

§

UnitAbility

Implementations§

Source §

impl Item

Source

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

Returns a path where items of this type are kept in the script files. Can be "" for items that are built in.

These paths are used both for the user in error reports, and to find the items when loading them.

Source

pub fn confidence(self) -> Confidence

Confidence value to use when reporting that an item is missing. Should be Strong for most, Weak for items that aren’t defined anywhere but just used (such as gfx flags).

Source

pub fn severity(self) -> Severity

Severity value to use when reporting that an item is missing.

Error - most things
Warning - things that only impact visuals or presentation
Untidy - things that don’t matter much at all
Fatal - things that cause crashes if they’re missing

This is only one piece of the severity puzzle. It can also depend on the caller who’s expecting the item to exist. That part isn’t handled yet.

Trait Implementations§

Source §

impl Clone for Item

Source §

fn clone(&self) -> Item

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for Item

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Display for Item

Display items in separated word case for maximum friendliness.

Unfortunately there’s no option for this in strum so we have to roll our own by using snake_case and changing the _ to a space.

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'_derivative_strum> From<&'_derivative_strum Item> for &'static str

Source §

fn from(x: &'_derivative_strum Item) -> &'static str

Converts to this type from the input type.

Source §

impl From<Item> for &'static str

Source §

fn from(x: Item) -> &'static str

Converts to this type from the input type.

Source §

impl Hash for Item

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 IntoEnumIterator for Item

Source §

type Iterator = ItemIter

Source §

fn iter() -> ItemIter ⓘ

Source §

impl Ord for Item

Source §

fn cmp(&self, other: &Item) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

Source §

impl PartialEq for Item

Source §

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

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

1.0.0 · Source§

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

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

Source §

impl PartialOrd for Item

Source §

fn partial_cmp(&self, other: &Item) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

impl Copy for Item

Source §

impl Eq for Item

Source §

impl StructuralPartialEq for Item

Auto Trait Implementations§

§

impl Freeze for Item

§

impl RefUnwindSafe for Item

§

impl Send for Item

§

impl Sync for Item

§

impl Unpin for Item

§

impl UnwindSafe for Item

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

§

impl<T> AsAny for T
where T: Any,

§

fn as_any(&self) -> &(dyn Any + 'static)

§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

§

fn type_name(&self) -> &'static str

Gets the type name of self

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

§

impl<T> Downcast for T
where T: AsAny + ?Sized,

§

fn is<T>(&self) -> bool
where T: AsAny,

Returns true if the boxed type is the same as T. Read more

§

fn downcast_ref<T>(&self) -> Option<&T>
where T: AsAny,

Forward to the method defined on the type Any.

§

fn downcast_mut<T>(&mut self) -> Option<&mut T>
where T: AsAny,

Forward to the method defined on the type Any.

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§