LuaDocs/SceneObject

From Data Realms Wiki

Contents 1 Parent: Entity 2 Properties 2.1 ClassName 2.2 Pos 2.3 HFlipped 2.4 RotAngle 2.5 Team 2.6 GoldValue 2.7 GoldValueString 2.8 IsBuyable 2.9 TotalValue 3 Functions 3.1 IsOnScenePoint

Parent: Entity

Abstract Class. The base class shared by Both TerrainObject:s and MovableObject:s, ie anything that can be places in a scene.

Go back to Class Index

Properties

ClassName

The class name of this SceneObject.A string with the friendly-formatted type name of this object.

Pos

The absolute position of this SceneObject.A Vector describing the current absolute position in pixels.

HFlipped

Returns whether this is being drawn flipped horizontally (around the vertical axis), or not.Whether flipped or not.

RotAngle

The current rotational angle of of this, in radians.The rotational angle of this, in radians.

Team

Gets which team this belongs to.The currently assigned team number.

GoldValue

Read-only property. The cost to purchase this item, in oz's of gold.The cost, in oz of gold.

GoldValueString

Read-only property. A descriptive string describing the cost to purchase this item, in oz's of gold.The cost, described in a friendly to read string: "100oz", or "Free"

IsBuyable

Read-only property. Shows whether this should appear in teh buy menus at all.Buyable or not.

TotalValue

Read-only property. The total liquidation value of this.The current value of this and all contained assets.

Functions

IsOnScenePoint

Indicates whether this' current graphical representation overlaps a point in absolute scene coordinates.

Arguments:

• The point in absolute scene coordinates.

Return value:

Whether this' graphical rep overlaps the scene point.

Go back to Class Index