Entity Library API

Attributes.rogue

enum Attributes [bitflags]

incorporates CommonCompoundMethods

Categories

Category	Value	Description
ACTIVE	1
INVISIBLE	2
INTANGIBLE	4
POINTER_PASSTHROUGH	8
MODIFIED	16
FOREGROUND	32
STARTED	64
H_FLIP	128
V_FLIP	256
MANUALLY_UPDATE_CONTENT_LAYOUT	512
CLIP	1024
CONSTANT_WIDTH	2048
CONSTANT_HEIGHT	4096

Global Properties

Name	Type	Description
categories	Attributes[]

Global Methods

Signature	Return Type	Description
create( name:String )	Attributes
create( value:Int )	Attributes

Properties

Name	Type	Description
value	Int

Methods

Signature	Return Type	Description
active()	Logical
clip()	Logical
constant_height()	Logical
constant_size()	Logical
constant_width()	Logical
description()	String
foreground()	Logical
h_flip()	Logical
hashcode()	Int
intangible()	Logical
invisible()	Logical
manually_update_content_layout()	Logical
modified()	Logical
name()	String
operator!()	Attributes
operator?()	Logical
operator&( flag:Attributes )	Attributes
operator==( other:Attributes )	Logical
operator|( flag:Attributes )	Attributes
pointer_passthrough()	Logical
print_to( buffer:PrintWriter )
set_active( setting:Logical )
set_clip( setting:Logical )
set_constant_height( setting:Logical )
set_constant_size( setting:Logical )
set_constant_width( setting:Logical )
set_foreground( setting:Logical )
set_h_flip( setting:Logical )
set_intangible( setting:Logical )
set_invisible( setting:Logical )
set_manually_update_content_layout( setting:Logical )
set_modified( setting:Logical )
set_pointer_passthrough( setting:Logical )
set_started( setting:Logical )
set_v_flip( setting:Logical )
started()	Logical
to<<Int>>()	Int
to<<Object>>()	Object
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo
v_flip()	Logical

Entity.rogue

class Entity

extends Node<<Entity>>

Global Properties

Name	Type	Description
next_internal_id	Int

Properties

Name	Type	Description
actions	Action
attributes	Attributes
count	Int
entity_id	GlobalID
first_child	Entity
internal_id	Int
last_child	Entity
next	Entity
parent	Entity
script	EntityScript
structure_modified	Logical

Methods

Signature	Return Type	Description
init()
init( entity_id:GlobalID )
activate()
attach_script( new_script:EntityScript )
change_script( new_script:EntityScript )
cloned()	Entity
deactivate()
description()	String
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
draw()
find( id:GlobalID, [arg=undefined:Variant], &up )	Variant
get( id:GlobalID, [arg=undefined:Variant] )	Variant
h_flip()	Logical
hide()
init_object()
init_clone( existing:Entity )
is_hidden()	Logical
is_pointer_passthrough()	Logical
is_tangible()	Logical
is_visible()	Logical
on_activate()
on_begin_draw()
on_begin_update()
on_cleanup()
on_deactivate()
on_draw()
on_draw_over()
on_end_draw()
on_end_update()
on_hide()
on_show()
on_start()
on_update()
set_clip( setting:Logical )
set_h_flip( setting:Logical )
set_is_pointer_passthrough( setting:Logical )
set_is_tangible( setting:Logical )
set_is_visible( setting:Logical )
set_v_flip( setting:Logical )
show()
start()
to<<String>>()	String
update()
v_flip()	Logical

Entity2D.rogue

class Entity2D

extends Entity

Properties

Name	Type	Description
actions	Action
anchor	Anchor
attributes	Attributes
count	Int
entity_id	GlobalID
first_child	Entity
internal_id	Int
last_child	Entity
natural_size	XY
next	Entity
parent	Entity
position	XY
rotation	Quaternion
scale	XY
scale_z	Real
script	EntityScript
structure_modified	Logical
z	Real

Methods

Signature	Return Type	Description
init()
init( natural_size:XY, [script=null:EntityScript] )
init( script:EntityScript )
anchor_bottom()
anchor_bottom_left()
anchor_bottom_right()
anchor_center()
anchor_left()
anchor_right()
anchor_top()
anchor_top_left()
anchor_top_right()
cloned()	Entity2D
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
init_clone( existing:Entity2D )
reset_size( natural_size:XY, [scale=XY(1.0):XY] )
rotation_x()	Radians
rotation_y()	Radians
rotation_z()	Radians
scale_to_fill( bounds:Box )
scale_to_fill( size:XY )
scale_to_fit( bounds:Box )
scale_to_fit( size:XY )
scale_to_height( height:Real )
scale_to_width( width:Real )
set_rotation( degrees:Degrees )
set_rotation( degrees:DegreesXYZ )
set_rotation( radians:Radians )
set_rotation( radians:RadiansXYZ )
set_rotation( rotation:Quaternion )
set_rotation_x( radians:Radians )
set_rotation_y( radians:Radians )
set_rotation_z( radians:Radians )
set_scale( scale:Real )
set_scale( scale:XY )
set_scale( scale:XYZ )
set_size( natural_size:XY, scale:XY )
set_size( size:XY )
size()	XY

Entity3D.rogue

class Entity3D

extends Entity

Properties

Name	Type	Description
actions	Action
anchor	Anchor
attributes	Attributes
count	Int
entity_id	GlobalID
first_child	Entity
internal_id	Int
last_child	Entity
next	Entity
parent	Entity
position	XYZ
rotation	Quaternion
scale	XYZ
script	EntityScript
size	XYZ
structure_modified	Logical

Methods

Signature	Return Type	Description
cloned()	Entity3D
dispatch_on<<$VisitorType>>( visitor:$VisitorType )	Entity
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
set_position( pos:XY )
set_position( position:XYZ )
set_rotation( rotation:Quaternion )
set_rotation( z:Radians )
set_scale( s:XY )
set_scale( scale:XYZ )
set_size( size:XYZ )
set_size( sz:XY )

EntityScript.rogue

class Entity2DScript

extends EntityScript

Properties

Name	Type	Description
concurrent_state	EntityScript
entity	Entity
is_exited	Logical	flag that assists when states finish outside of updated()
is_started	Logical
next_state	EntityScript

Methods

Signature	Return Type	Description
init()
init( entity:Entity2D )
entity()	Entity2D
position()	XY
set_position( position:XY )	XY

class EntityScript

extends ActiveState<<EntityScript>>

Properties

Name	Type	Description
concurrent_state	EntityScript
entity	Entity
is_exited	Logical	flag that assists when states finish outside of updated()
is_started	Logical
next_state	EntityScript

Methods

Signature	Return Type	Description
init()
init( entity:Entity )
change_script( new_script:EntityScript )
entity()	Entity
on_draw()
on_draw_over()
on_update_layout()

Properties.rogue

class Properties [compound]

incorporates CommonCompoundMethods

Global Methods

Signature	Return Type	Description
create( entity:Entity )	Properties

Properties

Name	Type	Description
entity	Entity

Methods

Signature	Return Type	Description
description()	String
get( name:String )	Variant
operator==( other:Properties )	Logical
print_to( buffer:PrintWriter )
set( name:String, value:Variant )
to<<Object>>()	Boxed<<Properties>>
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo