EntityGetClass

ISettlers4Api::EntityGetClass method

Returns the class enum of an entity with a specified ID.

Syntax

S4_ENTITY_ENUM ISettlers4Api::EntityGetClass(
	WORD entity
);

Parameters

entity

This id of the entity that represents the entity in the entity pool.

Return value

Returns one of the following values.

Value
S4_ENTITY_UNKNOWN 0
S4_ENTITY_BUILDING 1
S4_ENTITY_PILE 2
S4_ENTITY_SETTLER 3
S4_ENTITY_LANDANIMAL 4
S4_ENTITY_CART 5
S4_ENTITY_CATAPULT_MAYA 6
S4_ENTITY_CATAPULT_TROJAN 7
S4_ENTITY_CATAPULT_ROMAN 8
S4_ENTITY_CATAPULT_VIKING 9
S4_ENTITY_FERRY 10
S4_ENTITY_TRANSPORTSHIP 11
S4_ENTITY_WARSHIP_MAYA 12
S4_ENTITY_WARSHIP_TROJAN 13
S4_ENTITY_WARSHIP_ROMAN 14
S4_ENTITY_WARSHIP_VIKING 15
S4_ENTITY_MANAKOPTER 16
S4_ENTITY_DECO 17
S4_ENTITY_HIVE 18
S4_ENTITY_MUSHROOM 19
S4_ENTITY_PLANT 20
S4_ENTITY_SHADOW_HERB 21
S4_ENTITY_STONE 22
S4_ENTITY_TREE 23

Remarks

none

Requirements

Minimum API Level	2
Target Edition	Any
Header	S4ModApi.h
Library	S4ModApi.lib
DLL	S4ModApi.dll

See also

ISettlers4Api