-
Notifications
You must be signed in to change notification settings - Fork 5
IsObjectOfType
nyfrk edited this page Feb 3, 2022
·
4 revisions
Checks whether a specified object in the settler pool is of a specific type.
This method is obsolete as of version 2.0. Consider using ISettlers4Api::EntityGetClass.
BOOL ISettlers4Api::IsObjectOfType(
WORD object,
S4_OBJECT_TYPE type
);object
This parameter can be one of the following values.
| Value | Description |
|---|---|
| S4_OBJECT_UNKNOWN | The object pool is not accessible. |
| S4_OBJECT_EMPTY | The object in the pool is free. |
| S4_OBJECT_TRIBE_NONE | Object is a object that cannot be mapped to a tribe. |
| S4_OBJECT_TRIBE | Object is a object that can be mapped to a tribe. |
| S4_OBJECT_TRIBE_ROMAN | Object is roman object. |
| S4_OBJECT_TRIBE_VIKING | Object is viking object. |
| S4_OBJECT_TRIBE_MAYA | Object is mayan object. |
| S4_OBJECT_TRIBE_DARK | Object is dark tribe object. |
| S4_OBJECT_TRIBE_TROJAN | Object is trojan object. |
| S4_OBJECT_GOOD | Object is a good. |
| S4_OBJECT_GOOD_AGAVE | |
| S4_OBJECT_GOOD_AMMO | |
| S4_OBJECT_GOOD_ARMOR | |
| S4_OBJECT_GOOD_AXE | |
| S4_OBJECT_GOOD_BATTLEAXE | |
| S4_OBJECT_GOOD_BLOWGUN | |
| S4_OBJECT_GOOD_BOARD | |
| S4_OBJECT_GOOD_BOW | |
| S4_OBJECT_GOOD_BREAD | |
| S4_OBJECT_GOOD_COAL | |
| S4_OBJECT_GOOD_FISH | |
| S4_OBJECT_GOOD_FLOUR | |
| S4_OBJECT_GOOD_GOAT | |
| S4_OBJECT_GOOD_GOLDBAR | |
| S4_OBJECT_GOOD_GOLDORE | |
| S4_OBJECT_GOOD_GRAIN | |
| S4_OBJECT_GOOD_GUNPOWDER | |
| S4_OBJECT_GOOD_HAMMER | |
| S4_OBJECT_GOOD_HONEY | |
| S4_OBJECT_GOOD_IRONBAR | |
| S4_OBJECT_GOOD_IRONORE | |
| S4_OBJECT_GOOD_LOG | |
| S4_OBJECT_GOOD_MEAD | |
| S4_OBJECT_GOOD_MEAT | |
| S4_OBJECT_GOOD_PICKAXE | |
| S4_OBJECT_GOOD_PIG | |
| S4_OBJECT_GOOD_ROD | |
| S4_OBJECT_GOOD_SAW | |
| S4_OBJECT_GOOD_SCYTHE | |
| S4_OBJECT_GOOD_SHEEP | |
| S4_OBJECT_GOOD_SHOVEL | |
| S4_OBJECT_GOOD_STONE | |
| S4_OBJECT_GOOD_SULFUR | |
| S4_OBJECT_GOOD_SWORD | |
| S4_OBJECT_GOOD_TEQUILA | |
| S4_OBJECT_GOOD_WATER | |
| S4_OBJECT_GOOD_WINE | |
| S4_OBJECT_GOOD_BACKPACKCATAPULT | |
| S4_OBJECT_GOOD_GOOSE | |
| S4_OBJECT_GOOD_EXPLOSIVEARROW | |
| S4_OBJECT_GOOD_SUNFLOWEROIL | |
| S4_OBJECT_GOOD_SUNFLOWER | |
| S4_OBJECT_BUILDING | Object is a building. |
| S4_OBJECT_BUILDING_READY | not implemented yet |
| S4_OBJECT_BUILDING_UNDERCONSTRUCTION | not implemented yet |
| S4_OBJECT_BUILDING_WOODCUTTERHUT | |
| S4_OBJECT_BUILDING_FORESTERHUT | |
| S4_OBJECT_BUILDING_SAWMILL | |
| S4_OBJECT_BUILDING_STONECUTTERHUT | |
| S4_OBJECT_BUILDING_WATERWORKHUT | |
| S4_OBJECT_BUILDING_FISHERHUT | |
| S4_OBJECT_BUILDING_HUNTERHUT | |
| S4_OBJECT_BUILDING_SLAUGHTERHOUSE | |
| S4_OBJECT_BUILDING_MILL | |
| S4_OBJECT_BUILDING_BAKERY | |
| S4_OBJECT_BUILDING_GRAINFARM | |
| S4_OBJECT_BUILDING_ANIMALRANCH | |
| S4_OBJECT_BUILDING_DONKEYRANCH | |
| S4_OBJECT_BUILDING_STONEMINE | |
| S4_OBJECT_BUILDING_IRONMINE | |
| S4_OBJECT_BUILDING_GOLDMINE | |
| S4_OBJECT_BUILDING_COALMINE | |
| S4_OBJECT_BUILDING_SULFURMINE | |
| S4_OBJECT_BUILDING_SMELTGOLD | |
| S4_OBJECT_BUILDING_SMELTIRON | |
| S4_OBJECT_BUILDING_TOOLSMITH | |
| S4_OBJECT_BUILDING_WEAPONSMITH | |
| S4_OBJECT_BUILDING_VEHICLEHALL | |
| S4_OBJECT_BUILDING_BARRACKS | |
| S4_OBJECT_BUILDING_CHARCOALMAKER | |
| S4_OBJECT_BUILDING_TRAININGCENTER | |
| S4_OBJECT_BUILDING_HEALERHUT | |
| S4_OBJECT_BUILDING_AMMOMAKERHUT | |
| S4_OBJECT_BUILDING_GUNPOWDERMAKERHUT | |
| S4_OBJECT_BUILDING_LANDSCAPEMAKERHUT | |
| S4_OBJECT_BUILDING_SHIPYARD | |
| S4_OBJECT_BUILDING_PORT | |
| S4_OBJECT_BUILDING_MARKETPLACE | |
| S4_OBJECT_BUILDING_STORAGEAREA | |
| S4_OBJECT_BUILDING_VINYARD | |
| S4_OBJECT_BUILDING_AGAVEFARMERHUT | |
| S4_OBJECT_BUILDING_TEQUILAMAKERHUT | |
| S4_OBJECT_BUILDING_BEEKEEPERHUT | |
| S4_OBJECT_BUILDING_MEADMAKERHUT | |
| S4_OBJECT_BUILDING_RESIDENCESMALL | |
| S4_OBJECT_BUILDING_RESIDENCEMEDIUM | |
| S4_OBJECT_BUILDING_RESIDENCEBIG | |
| S4_OBJECT_BUILDING_SMALLTEMPLE | |
| S4_OBJECT_BUILDING_BIGTEMPLE | |
| S4_OBJECT_BUILDING_LOOKOUTTOWER | |
| S4_OBJECT_BUILDING_GUARDTOWERSMALL | |
| S4_OBJECT_BUILDING_GUARDTOWERBIG | |
| S4_OBJECT_BUILDING_CASTLE | |
| S4_OBJECT_BUILDING_MUSHROOMFARM | |
| S4_OBJECT_BUILDING_DARKTEMPLE | |
| S4_OBJECT_BUILDING_FORTRESS | |
| S4_OBJECT_BUILDING_PORTA | |
| S4_OBJECT_BUILDING_PORTB | |
| S4_OBJECT_BUILDING_PORTC | |
| S4_OBJECT_BUILDING_PORTD | |
| S4_OBJECT_BUILDING_PORTE | |
| S4_OBJECT_BUILDING_PORTF | |
| S4_OBJECT_BUILDING_SHIPYARDA | |
| S4_OBJECT_BUILDING_SHIPYARDB | |
| S4_OBJECT_BUILDING_SHIPYARDC | |
| S4_OBJECT_BUILDING_SHIPYARDD | |
| S4_OBJECT_BUILDING_SHIPYARDE | |
| S4_OBJECT_BUILDING_SHIPYARDF | |
| S4_OBJECT_BUILDING_EYECATCHER01 | |
| S4_OBJECT_BUILDING_EYECATCHER02 | |
| S4_OBJECT_BUILDING_EYECATCHER03 | |
| S4_OBJECT_BUILDING_EYECATCHER04 | |
| S4_OBJECT_BUILDING_EYECATCHER05 | |
| S4_OBJECT_BUILDING_EYECATCHER06 | |
| S4_OBJECT_BUILDING_EYECATCHER07 | |
| S4_OBJECT_BUILDING_EYECATCHER08 | |
| S4_OBJECT_BUILDING_EYECATCHER09 | |
| S4_OBJECT_BUILDING_EYECATCHER10 | |
| S4_OBJECT_BUILDING_EYECATCHER11 | |
| S4_OBJECT_BUILDING_EYECATCHER12 | |
| S4_OBJECT_BUILDING_SHIPYARDG | |
| S4_OBJECT_BUILDING_SHIPYARDH | |
| S4_OBJECT_BUILDING_PORTG | |
| S4_OBJECT_BUILDING_PORTH | |
| S4_OBJECT_BUILDING_MANACOPTERHALL | |
| S4_OBJECT_BUILDING_SUNFLOWEROILMAKERHUT | |
| S4_OBJECT_BUILDING_SUNFLOWERFARMERHUT | |
| S4_OBJECT_SETTLER | Object is a settler. |
| S4_OBJECT_SETTLER_CARRIER | |
| S4_OBJECT_SETTLER_DIGGER | |
| S4_OBJECT_SETTLER_BUILDER | |
| S4_OBJECT_SETTLER_WOODCUTTER | |
| S4_OBJECT_SETTLER_STONECUTTER | |
| S4_OBJECT_SETTLER_FORESTER | |
| S4_OBJECT_SETTLER_FARMERGRAIN | |
| S4_OBJECT_SETTLER_FARMERANIMALS | |
| S4_OBJECT_SETTLER_FISHER | |
| S4_OBJECT_SETTLER_WATERWORKER | |
| S4_OBJECT_SETTLER_HUNTER | |
| S4_OBJECT_SETTLER_SAWMILLWORKER | |
| S4_OBJECT_SETTLER_SMELTER | |
| S4_OBJECT_SETTLER_MINEWORKER | |
| S4_OBJECT_SETTLER_SMITH | |
| S4_OBJECT_SETTLER_MILLER | |
| S4_OBJECT_SETTLER_BAKER | |
| S4_OBJECT_SETTLER_BUTCHER | |
| S4_OBJECT_SETTLER_SHIPYARDWORKER | |
| S4_OBJECT_SETTLER_HEALER | |
| S4_OBJECT_SETTLER_CHARCOALMAKER | |
| S4_OBJECT_SETTLER_AMMOMAKER | |
| S4_OBJECT_SETTLER_VEHICLEMAKER | |
| S4_OBJECT_SETTLER_VINTNER | |
| S4_OBJECT_SETTLER_BEEKEEPER | |
| S4_OBJECT_SETTLER_MEADMAKER | |
| S4_OBJECT_SETTLER_AGAVEFARMER | |
| S4_OBJECT_SETTLER_TEQUILAMAKER | |
| S4_OBJECT_SETTLER_SWORDSMAN_01 | |
| S4_OBJECT_SETTLER_SWORDSMAN_02 | |
| S4_OBJECT_SETTLER_SWORDSMAN_03 | |
| S4_OBJECT_SETTLER_BOWMAN_01 | |
| S4_OBJECT_SETTLER_BOWMAN_02 | |
| S4_OBJECT_SETTLER_BOWMAN_03 | |
| S4_OBJECT_SETTLER_MEDIC_01 | |
| S4_OBJECT_SETTLER_MEDIC_02 | |
| S4_OBJECT_SETTLER_MEDIC_03 | |
| S4_OBJECT_SETTLER_AXEWARRIOR_01 | |
| S4_OBJECT_SETTLER_AXEWARRIOR_02 | |
| S4_OBJECT_SETTLER_AXEWARRIOR_03 | |
| S4_OBJECT_SETTLER_BLOWGUNWARRIOR_01 | |
| S4_OBJECT_SETTLER_BLOWGUNWARRIOR_02 | |
| S4_OBJECT_SETTLER_BLOWGUNWARRIOR_03 | |
| S4_OBJECT_SETTLER_SQUADLEADER | |
| S4_OBJECT_SETTLER_PRIEST | |
| S4_OBJECT_SETTLER_SABOTEUR | |
| S4_OBJECT_SETTLER_PIONEER | |
| S4_OBJECT_SETTLER_THIEF | |
| S4_OBJECT_SETTLER_GEOLOGIST | |
| S4_OBJECT_SETTLER_GARDENER | |
| S4_OBJECT_SETTLER_LANDSCAPER | |
| S4_OBJECT_SETTLER_DARKGARDENER | |
| S4_OBJECT_SETTLER_MUSHROOMFARMER | |
| S4_OBJECT_SETTLER_SHAMAN | |
| S4_OBJECT_SETTLER_SLAVED_SETTLER | |
| S4_OBJECT_SETTLER_TEMPLE_SERVANT | |
| S4_OBJECT_SETTLER_ANGEL_01 | |
| S4_OBJECT_SETTLER_ANGEL_02 | |
| S4_OBJECT_SETTLER_ANGEL_03 | |
| S4_OBJECT_SETTLER_DONKEY | |
| S4_OBJECT_SETTLER_BACKPACKCATAPULTIST_01 | |
| S4_OBJECT_SETTLER_BACKPACKCATAPULTIST_02 | |
| S4_OBJECT_SETTLER_BACKPACKCATAPULTIST_03 | |
| S4_OBJECT_SETTLER_SUNFLOWERFARMER | |
| S4_OBJECT_SETTLER_SUNFLOWEROILMAKER | |
| S4_OBJECT_SETTLER_MANACOPTERMASTER | |
| S4_OBJECT_VEHICLE | Object is a vehicle. |
| S4_OBJECT_VEHICLE_WARSHIP | |
| S4_OBJECT_VEHICLE_FERRY | |
| S4_OBJECT_VEHICLE_TRANSPORTSHIP | |
| S4_OBJECT_VEHICLE_WARMACHINE | |
| S4_OBJECT_VEHICLE_CART | |
| S4_OBJECT_VEHICLE_FOUNDATION_CART | |
| S4_OBJECT_PLANT | Object is a plant. |
| S4_OBJECT_PLANT_1 | |
| S4_OBJECT_PLANT_ROMAN_TREE | |
| S4_OBJECT_PLANT_MAYAN_TREE | |
| S4_OBJECT_PLANT_TROJAN_TREE | |
| S4_OBJECT_PLANT_WHEAT | |
| S4_OBJECT_PLANT_SUNFLOWER |
Returns TRUE if the specified object is of the specified type, FALSE otherwise.
Not every object and type is yet added to the list. Plants are very incomplete and Animals have not yet been added. The list will be expanding in the future.
| Minimum API Level | 1 |
| Maximum API Level | 1 |
| Target Edition | Any |
| Header | S4ModApi.h |
| Library | S4ModApi.lib |
| DLL | S4ModApi.dll |