Overseer.EntityFactory

Overseer.EntityFactory

This object is responsible for the creation of new entity objects on the map. Set the properties for the new object, call the SetPos method to position the new symbol, call the SetSize method to establish the new symbol's size, then call the Create method to bring the new symbol into being. The tag number of the new symbol is returned.

Properties (Methods)

activationLimit, activationType, clickRadius, hotspot, layerID, name, solid, visible

	long activationLimit
		This property is only used if the new object is to be a hotspot. Set this to the activation limit of the new entity. It is the same as the activationLimit property of the Entity object.
	long activationType
		This property is only used if the new object is to be a hotspot. Set this to the activation type of the new entity. It is the same as the activationType property of the Entity object.
	double clickRadius
		This property is only used if the new object is to be a hotspot. Set this to the click radius of the new entity. It is the same as the clickRadius property of the Entity object.
	boolean hotspot
		This property defaults to false. Set this to true prior to calling Create to have the new entity created as a hotspot.
	long layerID
		Set this to the layer ID for the layer that will contain the object. The layer ID for a named layer can be found using the Overseer.GetLayerID() method.
	String name
		The name of the symbol to be created.
	boolean solid
		Set this to *true* for a solid object, *false* for a transparent one.
	boolean visible
		Set this to *true* for a visible object, *false* for a hidden one.

Methods (Properties)

Create, Delete, SetPos, SetSize

	long Create()
		Call this method to create the entity after configuring it using the above properties. This method returns the tag number of the new entity created.
	boolean Delete(long tagID
		Deletes tagID from the map. tagID is the tag number for the object to delete. This method returns *true* if tagID was found and deleted.
	void SetPos(double x, double y, double z)
		Sets the position of the bottom center of the new symbol.
	void SetSize(double x, double y, double z)
		Sets the size of the new symbol.