MPUZ: Object Variables

This information is subject to change.

MPUZ
Development Main Page
Basics
Creating a simple object Creating a simple level Creating a simple map
Intermediate
Fun with LinkIDs Using Dialog Files Object Property Values
Advanced
none
Reference
Function and Keyword List Object Variables Dialog Commands Object List Plugin List
[Edit]

Objects in MPUZ have a list of variables that are used to store various information. Following is a list of those variables, which are generally accessed like selector.sysid:

Variables and Object Structure

Note: the values of these variables are examples only.

object = {
    objid = "MP_OBJECT",
    linkid = 0,
    --
    x = 0,
    y = 0,
    z = 0,
    width = nil,  -- *
    height = nil, -- *
    left = nil,   -- *, **
    right = nil,  -- *, **
    top = nil,    -- *, **
    bottom = nil, -- *, **
    xscale = 1,
    yscale = 1,
    angle = 0,
    alpha = 1,
    property = { },
    sys = { },
    cust = { },
    group = { },
    plugin = { },
}
-- *: these values are not stored explicitly; instead, they are generated on-the-fly when their fields are accessed
-- **: returns multiple values, not a table

These are not the only variables which the engine may store in an object, but these are so-called "standard" variables which all objects will have.

Within these tutorials, a subtable cust will be used to store custom variables that are unique to a single object, such as me.cust.health. MPUZ itself may store various other variables in the sys subtable; which variables these are depends upon certain aspects of the object code (such as variables used by plugins). Attached plugins are stored as keys in the plugin subtable, with their current status as their value.

Events

Triggered

• onCreate( INSTANCE self, INSTANCE caller ): called after the object is first created. For any object, this is the first event ever to be called. caller is a reference to the object that called this event, or a reference (null) to the Null Object if something other than another object called the event.
• onDestroy( INSTANCE self, INSTANCE caller ): called before the object is destroyed. This is generally the last event called for objects, provided onDestroy does not call any other events itself. caller is, again, the calling object, or the Null Object.

Continuous