Standard-UserAttributes

Aus UniversalProcessKit
Wechseln zu: Navigation, Suche

Diese UserAttributes können in allen Modulen des UPK verwendet werden.


Inhaltsverzeichnis

Allgemein

type (string)

Gibt an, um welches Modul es sich handelt, d.h. welche Funktion es haben soll.

Ausprägung Beschreibung
activatortrigger siehe ActivatorTrigger
animator siehe Animator
balertrigger siehe BalerTrigger
baletrigger siehe BaleTrigger
comparator siehe Comparator
displaytrigger siehe DisplayTrigger
dumptrigger siehe DumpTrigger
emptytrigger siehe EmptyTrigger
entitytrigger siehe EntityTrigger
filltrigger siehe FillTrigger
gasstationtrigger siehe GasStationTrigger
liquidmanurefilltrigger siehe LiquidManureFillTrigger
mover siehe Mover
pallettrigger siehe PalletTrigger
parktrigger siehe ParkTrigger
playerspawner siehe PlayerSpawner
processor siehe Processor
selltarget siehe SellTarget
sowingmachinefilltrigger siehe SowingMachineFillTrigger
sprayerfilltrigger siehe SprayerFillTrigger
switcher siehe Switcher
tiptrigger siehe TipTrigger
unspecified siehe Unspecified
washtrigger siehe WashTrigger
waterfilltrigger siehe WaterFillTrigger

isEnabled (boolean)

Legt fest, ob das Modul beim Kauf des Mods/ zu Beginn des Spiels aktiviert oder deaktiviert ist.

Ausprägung Beschreibung
true (default) das Modul ist aktiviert
false das Modul ist deaktiviert


adjustToTerrainHeight (boolean)

Dieses UserAttribute ist auch für alle Nodes oder TriggerGroups im Mod anwendbar, die kein UPK-Modul sind. Es funktioniert aber nur für platzierbare Objekte.

Ausprägung Beschreibung
true Verschiebt den Node-Ursprung auf Höhe des Terrains.
false (default) Verändert die Lage der Node nicht.


Handhabung von Füllständen

store (string)

Regelt die Speicherung und Verwaltung von Füllständen.

Ausprägung Beschreibung
(ohne) (default) Das Modul greift auf den selben Speicher zu wie das übergeordnete Modul und nutzt dessen Einstellungen.

Nicht kombinierbar mit capacity oder capacities.
Die Base speichert standardmäßig jeden Fülltyp separat ab.

(Auflistung von Fülltypen) Die Speicherung erfolgt separat für jeden aufgelisteten Fülltyp. Bei nicht aufgelisteten Fülltypen wird an das übergeordnete Modul weiterverwiesen.

Kombinierbar mit capacities
Bsp: „wheat“, „barley water“, „manure wheat barley“

single Speichert nur einen einzigen Fülltyp ab. Sobald ein Füllstand gespeichert ist, ist auch dessen Fülltyp fixiert. Weitere Füllstände anderer Fülltypen können dann nicht mehr gespeichert werden.

Der Fülltyp kann sich erst ändern, wenn der Füllstand des vorherigen wieder leer ist.
Kombinierbar mit capacities

fifo „first in – first out“: Füllstände, die zuerst in dem Modul gespeichert werden, werden als erste wieder ausgegeben.

Funktion ähnlich zu einem Rohr: Wenn man Weizen, Gerste und Raps in ein Rohr kippt, kommt auf der anderen Seite Weizen, Gerste und Raps in dieser Reihenfolge wieder raus.

filo „first in – last out“: Füllstände, die zuerst in dem Modul gespeichert werden, werden als letzte wieder ausgegeben.

Funktion ähnlich zu einem Fass: Wenn man Weizen, Gerste und Raps in ein Fass kippt, muss man Raps, Gerste und Weizen in dieser Reihenfolge wieder entnehmen, um es zu leeren.


capacity (float)

Legt den maximalen Standard-Füllstand fest. Bei separater und einzelner Füllstandsspeicherung gilt dies für jeden Fülltyp, für fifo und filo nur insgesamt.

Ausprägung Beschreibung
(ohne) (default)  Die Füllmenge ist unendlich.
(Zahl) Maximaler Füllstands-Wert

Bsp: „30000“, „6500“


capacities (string)

Ausprägung Beschreibung
(ohne) (default) Keine Ausnahmen für capacity
(Auflistung von Füllständen und Fülltypen) Legt die Füllstände für verschiedene Fülltypen fest. Für alle hier nicht aufgelisteten Fülltypen, die gespeichert werden, gilt capacity.

Nicht in Kombination mit store=“fifo“ oder store=“filo“.
Bsp: „6000 wheat“, „5000 water 1000 manure“


initialFillLevels (string)

Ausprägung Beschreibung
(ohne) (default) Alle Füllmengen sind beim Kauf des Mods/ zu Beginn des Spiels 0.
(Auflistung von Füllständen und Fülltypen) Setzt bestimmte Fülltypen einmalig beim Kauf/ beim Beginn des Spiels auf die angegebenen Werte.

Bsp: „500 wheat“, „300 water 60 manure“

convertFillTypes (string)

Ausprägung Beschreibung
(ohne) (default) Keine Fülltypen werden umgewandelt
(Auflistung von Fülltypen) Auflistung von Fülltypen, die jeweils in den zuerst aufgeführten umgewandelt werden sollen. Mehrere Auflistungen können durch Komma getrennt werden.

Am besten in dem Modul verwenden, wo der Ziel-Fülltyp gespeichert wird (siehe store).
Hinweis: Die umzuwandelnden Fülltypen müssen trotzdem bei Triggern als akzeptiert aufgeführt werden.
Bsp: Jede Strohart soll als Weizenstroh gespeichert werden:
„wheat_windrow oat_windrow rice_windrow“
Zudem soll Gras als Heu gespeichert werden:
„wheat_windrow oat_windrow rice_windrow, dryGrass_windrow grass_windrow“

Anzeige eines MapHotspots

showMapHotspot (boolean)

Legt durch Verwendung fest, ob das Modul überhaupt einen Hotspot anzeigen soll und durch den Wert, ob er standardmäßig ein- oder ausgeblendet ist.

Ausprägung Beschreibung
true Der Hotspot ist standardmäßig eingeblendet.
false (default) Der Hotspot ist standardmäßig ausgeblendet.


MapHotspot (string)

Als Icon kann man entweder ein eigenes (siehe MapHotspotIcon) verwenden, oder eins aus dem Spiel:

Ausprägung Beschreibung
(ohne) (default) Die Angabe bei MapHotspotIcon wird verwendet.
Bank Das Icon für die Bank.
FuelStation Das Icon für die Tankstelle.
Shop Das Icon für den Shop.
Phone Das Icon für das Telefon.
Eggs Das Icon für die Eier-Verkaufsstelle.
TipPlace Das Icon für eine Ablademöglichkeit.
TipPlaceGold Das Icon für eine Ablademöglichkeit (hervorgehoben).
Cows Das Icon für den Kuhstall.
Sheep Das Icon für die Schafwiese.
Chickens Das Icon für die Hühner.
Billboard Das Icon für die Missionstafel.

MapHotspotIcon (string)

Ausprägung Beschreibung
(ohne) (default) Ohne Festlegung wird das Icon für eine Ablademöglichkeit („TipPlace“) verwendet.
(Dateipfad) Gibt den Pfad zum Icon innerhalb des Mods an. Dafür muss auch modname in der base gesetzt sein.

showMapHotspotIfDisabled (boolean)

Ausprägung Beschreibung
true (default) Der Hotspot bleibt eingeblendet, wenn das Modul deaktiviert wird.
false Der Hotspot wird ausgeblendet, wenn das Modul deaktiviert wird.

Einbinden externer i3ds

loadI3D (string)

Lädt eine externe i3d-Datei. Sie wird als Kind des i3d-Objekts geladen und kann selbst UPK-UserAttribute beinhalten, die berücksichtigt werden.

Achtung: Die Ordnerstruktur wird mit einem Slash "/" markiert, nicht wie bei Windows üblich mit einem Backslash "\". Auch bei den Dateinamen wird zwischen Groß- und Kleinschreibung unterschieden, dh. die Dateien müssen exakt so geschrieben sein wie sie heißen.

Dieses UserAttribute ist auch für alle Nodes oder TriggerGroups im Mod anwendbar, die kein UPK-Modul sind.

Ausprägung Beschreibung
(ohne) (default) Keine Datei wird geladen.
(Dateiname) Name der zu ladenden Datei. Folgende Schlüsselwörter können am Anfang verwendet werden:

$data: wird mit dem Pfad zum Spieleordner ersetzt, bspw. "$data/maps/particleSystems/smokeParticleSystem.i3d"
$mods: wird mit dem Pfad zum Modordner ersetzt, bspw. "$mods/Parkhalle/halle.i3d"
Ansonsten wird im eigenen Modordner gesucht - UserAttribut "modname" bei der Base muss gesetzt sein!

prefixShapeNames (string)

Dieser String wird an alle i3d-Objekte vorn angefügt, um die Namen für die Action-UserAttributes show.. und hide.. unterscheidbar zu machen. Er ist hauptsächlich dafür gedacht, die Namen externer i3ds zu unterscheiden, falls sie mehrfach im Mod verwendet werden (bspw. "silo1_fillSound" und "silo2_fillSound").

Die Präfixe lassen sich schachteln, um bspw. mit derselben externen Silo-i3d die verschiedenen Silos der verschiedenen Höfe zu kennzeichnen ("hof1_silo1_...", "hof2_silo1_..." usw.).

Dieses UserAttribute ist auch für alle Nodes oder TriggerGroups im Mod anwendbar, die kein UPK-Modul sind.

Ausprägung Beschreibung
(ohne) (default) Kein Präfix wird vorn angefügt.
(Präfix) Erweiterung der Namen untergeordneter i3d-Objekte.

Bspw. "hof1_", "silo1_"

Kopiervorlage

Diese UserAttributes können zusätzlich zu jedem Modul verwendet werden.

   <Attribute name="isEnabled" type="boolean" value="true" />
   <Attribute name="adjustToTerrainHeight" type="boolean" value="false" />
   <Attribute name="store" type="string" value="" />
     <Attribute name="capacity" type="float" value="" />
     <Attribute name="capacities" type="string" value="" />
     <Attribute name="initialFillLevels" type="string" value="" />
     <Attribute name="convertFillTypes" type="string" value="" />
   <Attribute name="showMapHotspot" type="boolean" value="false" />
     <Attribute name="MapHotspot" type="string" value="" />
     <Attribute name="MapHotspotIcon" type="string" value="" />
     <Attribute name="showMapHotspotIfDisabled" type="boolean" value="false" />