Entity container object

The Entity container object allows you to incorporated an advanced interactive object (an entity) into your GUI windows. Entity containers can be queried using the Window.GetControl method.


Методы

SetFont Sets a normal font.
SetImage Sets a background image (sprite).
GetImage Returns the filename of the background sprite (or null if no sprite is set)
GetImageObject Returns a reference to the background sprite (or null if no sprite is set)
Focus Focuses the control.
MoveAfter Moves the control in z-order after a given control.
MoveBefore Moves the control in z-order before a given control.
MoveToTop Moves the control to the top of the z-order.
MoveToBottom Moves the control to the bottom of the z-order.
Actions
GetEntity Returns the entity object assigned to this container.
SetEntity Assigns an entity object to this container.

Атрибуты

Parent (только для чтения) Returns a reference to a parent window of this control (or null)
ParentNotify Specifies whether this control should notify its parent about events
Width A width of the control
Height A height of the control
Visible Specifies whether the control is visible
Disabled Specifies whether the control is disabled
Text A text the control displays
NextSibling (только для чтения) Returns a reference to the next control in z-order
PrevSibling (только для чтения) Returns a reference to the previous control in z-order
Type (только для чтения) Returns always "entity container"
Freezable Specifies if the contained entity should be frozen when a system exclusive window is active
Name Внутреннее имя объекта.
Caption Заголовок объекта.
AccCaption Специальный заголовок объекта, используемый специальными фукциями движка для людей с ослабленным зрением.
X Координата X объекта.
Y Координата Y объекта.
Height (только для чтения) Возвращает текущую высоту объекта (учитывает масштаб персонажей).
Filename (только для чтения) Возвращает имя файла объекта.
Ready (только для чтения) Возвращает true, если объект в настоящий момент не совершает никакого действия.
Interactive Указывает, должен ли объект реагировать на действия пользователя (быть интерактивным).
SoundPanning Указывает, должен ли звук, воспроизводимый данным объектом, панорамироваться в зависимости от его позиции на экране.
NonIntMouseEvents Указывает, должен ли объект реагировать на события MouseEntry и MouseLeave, даже в том случае, если игра работает в неинтерактивном режиме.
Movable Specifies whether the object can be moved by its sprites (in case the sprite frames have a "move" property set).
Scalable Specifies whether the object is affected by scene's scaling levels.
Rotatable Specifies whether the object is affected by scene's rotation levels.
Colorable Specifies whether the object is affected by scene's color regions.
AlphaColor Specifies an RGBA color of this object (overrides scene coloring); set to 0 to reset default behavior.
BlendMode Specifies how the object's image is blended with the background colors; 0...normal mode, 1...additive blending, 2...subtractive blending
Scale Specifies a scale of this object (overrides scene scaling); set to null to reset default behavior.
ScaleX Specifies horizontal scale of this object; set to null to reset default behavior.
ScaleY Specifies vertical scale of this object; set to null to reset default behavior.
RelativeScale Specifies a scale amount to be added to the default scene scale.
Rotate Specifies rotation of this object (in degrees); overrides scene rotation; set to null to reset default behavior; not available in compatibility mode
RelativeRotate Specifies a rotation amount to be added to the default scene rotation.

SetFont(Filename)

Sets a normal font.

Параметры

Filename
A filename of a font file to be used.

Возвращаемое значение

If the method succeeds, the return value is true.


SetImage(Filename)

Sets a background image (sprite).

Параметры

Filename
A filename of a sprite file to be used.

Возвращаемое значение

If the method succeeds, the return value is true.


GetImage()

Returns the filename of the background sprite (or null if no sprite is set)


GetImageObject()

Returns a reference to the background sprite (or null if no sprite is set)


Focus()

Focuses the control.


MoveAfter(Control)
MoveAfter(ControlName)

Moves the control in z-order after a given control.

Параметры

Control
A control object we will move our control after
ControlName
A name of a control object we will move our control after

Возвращаемое значение

If the method succeeds, the return value is true.


MoveBefore(Control)
MoveBefore(ControlName)

Moves the control in z-order before a given control.

Параметры

Control
A control object we will move our control before
ControlName
A name of a control object we will move our control before

Возвращаемое значение

If the method succeeds, the return value is true.


MoveToTop()

Moves the control to the top of the z-order.

Возвращаемое значение

If the method succeeds, the return value is true.


MoveToBottom()

Moves the control to the bottom of the z-order.

Возвращаемое значение

If the method succeeds, the return value is true.


GetEntity()

Returns the entity object assigned to this container.

Возвращаемое значение

Returns a reference to the entity object.


SetEntity(Filename)

Assigns an entity object to this container.

Параметры

Filename
The filename of the entity file to be assigned.

Возвращаемое значение

If the method succeeds, the return value is true.