Action.rogue

class Action

Global Properties

Name	Type	Description
global_timescale	Real

Properties

Name	Type	Description
concurrent_state	Action
dt	Real	time since last update
duration	Real
is_exited	Logical	flag that assists when states finish outside of updated()
is_started	Logical
next_state	Action
prev_time	Real	0 = not started
t	Real
timescale	Real

Methods

Signature	Return Type	Description
on_draw()
on_draw_over()
replace_action( new_action:Action )
timescale()	Real

ActiveState.rogue

class ActiveState<<$ExtendedType>>

extends Object

Global Methods

Signature	Return Type	Description
if_then( condition:Function()->Logical, if_true:$ExtendedType )	$ExtendedType
if_then_else( condition:Function()->Logical, if_true:$ExtendedType, if_false:$ExtendedType )	$ExtendedType
operator+( a:$ExtendedType, b:$ExtendedType )	$ExtendedType
operator\|( a:$ExtendedType, b:$ExtendedType )	$ExtendedType

Properties

Name	Type	Description
concurrent_state	$ExtendedType
is_exited	Logical	flag that assists when states finish outside of updated()
is_started	Logical
next_state	$ExtendedType

Methods

Signature	Return Type	Description
also( state:$ExtendedType )	$ExtendedType
and_then( state:$ExtendedType )	$ExtendedType
and_then_also( state:$ExtendedType )	$ExtendedType
call<<$method_name>>()		Calls specified method on this state and all concurrent states.
call<<$method_name,$ArgType>>( arg:$ArgType )		Calls specified method on this state and all concurrent states.
cancel()		Removes any next state and finishes this state.
cancel_all()		Cancels this state and all concurrent states
change( new_state:$ExtendedType )
count()	Int32
describe()	String
description()	String
exit()
find_active<<$FindType>>()	$ExtendedType	Returns any active state (this or a concurrent_state) that is instanceOf $FindType.
finish()
handle_activate()
handle_deactivate()
handle_finish()
insert_next( state:$ExtendedType )
is_finished()	Logical
last()	$ExtendedType	Returns the last state in this chain
on_activate()		In an ActivateState, on_activate() and on_start() are both always called. In a ProgressState or Action, on_activate() is always called but on_start() is not called if the action is an instant action defining on_execute().
on_deactivate()
on_finish()
on_start()
on_update()
removing( state:$ExtendedType )	$ExtendedType
start()
started()	$ExtendedType
to<<String>>()	String
update()
updated()	$ExtendedType

EasedValue.rogue

class EasedValue

extends EasedValue<<Real>>

Properties

Name	Type	Description
duration	Real
duration_fn	Function(Real)->Real
initial_value	Real
progress_fn	Function(Real)->Real
start_time_ms	Int
target_value	Real

class EasedValue<<$DataType>>

extends TargetValue<<$DataType>>

Properties

Name	Type	Description
duration	Real
duration_fn	Function($DataType)->Real
initial_value	$DataType
progress_fn	Function(Real)->Real
start_time_ms	Int
target_value	$DataType

Methods

Signature	Return Type	Description
init( initial_value:$DataType, [duration=0.5:Real], [progress_fn=ProgressFn.QUADRATIC:Function(Real)->Real], [duration_fn=null:Function($DataType)->Real] )
init( initial_value:$DataType, target_value:Real, duration:Real, [progress_fn=ProgressFn.QUADRATIC:Function(Real)->Real], [duration_fn=null:Function($DataType)->Real] )
delta()	$DataType
progress()	Real
reset( new_initial_value:Real, new_target_value:Real, [duration=null:Real?] )
set_target_value( new_target_value:$DataType )	EasedValue<<$DataType>>
set_value( new_value:$DataType )	EasedValue<<$DataType>>
value()	$DataType

class TargetValue<<$DataType>>

extends Object

Properties

Name	Type	Description
target_value	$DataType

Methods

Signature	Return Type	Description
set_target_value( target_value:$DataType )	TargetValue<<$DataType>>
set_value( target_value:$DataType )	TargetValue<<$DataType>>
value()	$DataType

ProgressFn.rogue

class ProgressFn

extends Object

Global Properties

Name	Type	Description
BACK	Function_1867
BACK_EASY_OUT	Function_1870
BACK_IN	Function_1868
BACK_OUT	Function_1869
BOUNCE	Function_1871
BOUNCE_IN	Function_1872
BOUNCE_OUT	Function_1873
CIRCULAR	Function_1874
CIRCULAR_IN	Function_1875
CIRCULAR_OUT	Function_1876
CUBIC	Function_1877
CUBIC_IN	Function_1878
CUBIC_IN_INVERSE	Function_1881
CUBIC_INVERSE	Function_1880
CUBIC_OUT	Function_1879
CUBIC_OUT_INVERSE	Function_1882
ELASTIC	Function_1883
ELASTIC_IN	Function_1884
ELASTIC_OUT	Function_1885
EXPONENTIAL	Function_1886
EXPONENTIAL_IN	Function_1887
EXPONENTIAL_OUT	Function_1888
LINEAR	Function_1889
QUADRATIC	Function_1890
QUADRATIC_IN	Function_1891
QUADRATIC_IN_INVERSE	Function_1894
QUADRATIC_INVERSE	Function_1893
QUADRATIC_OUT	Function_1892
QUADRATIC_OUT_INVERSE	Function_1895
QUARTIC	Function_1896
QUARTIC_IN	Function_1897
QUARTIC_OUT	Function_1898
QUINTIC	Function_1899
QUINTIC_IN	Function_1900
QUINTIC_OUT	Function_1901
SINE	Function_1902
SINE_IN	Function_1903
SINE_OUT	Function_1904
SMOOTHERSTEP	Function_1906
SMOOTHSTEP	Function_1905
SNAPBOUNCE	Function_1907

ProgressState.rogue

class ProgressState<<$ExtendedType>>

augments ProgressState<<$ExtendedType>>

extends ActiveState<<$ExtendedType>>

Description

Duration values

Global Methods

Signature	Return Type	Description
create( fn:Function() )	$ExtendedType
create( fn:Function(Real), duration:Real )	$ExtendedType
wait( duration:Real )	$ExtendedType
wait_for( condition:Function()->Logical, [duration=Rogue::_Doc_Gen_ExtendedType.INDEFINITE:Real] )	$ExtendedType
wait_for( entity:Entity )	$ExtendedType
yield()	$ExtendedType

Properties

Name	Type	Description
concurrent_state	$ExtendedType
dt	Real	time since last update
duration	Real
is_exited	Logical	flag that assists when states finish outside of updated()
is_started	Logical
next_state	$ExtendedType
prev_time	Real	0 = not started
t	Real

Methods

Signature	Return Type	Description
init()
init( duration:Real )
execute()		Internal use
finish()
is_finished()	Logical
on_execute()		Override to automatically make duration INSTANT
progress()	Real
started()	$ExtendedType	Starts the state if not already started, which can call on_execute(), but does not call update().
timescale()	Real
updated()	$ExtendedType

class ProgressStateYield<<$ExtendedType>>

extends $ExtendedType

Properties

Name	Type	Description
update_count	Int

Methods

Signature	Return Type	Description
is_finished()	Logical
on_update()

UpdateTimer.rogue

class UpdateTimer [compound]

incorporates CommonCompoundMethods

Global Methods

Signature	Return Type	Description
create( [ticks_per_second=60:Int], [tolerance=0.05:Real], [max_dt=0.1:Real], [time_fn=null:Function()->Real] )	UpdateTimer
create( interval:Real, threshold:Real, max_dt:Real, time_fn:Function()->Real )	UpdateTimer

Properties

Name	Type	Description
delta_ticks	Int
dt	Real
interval	Real
max_dt	Real
prev_time	Real
threshold	Real
time_debt	Real
time_fn	Function()->Real

Methods

Signature	Return Type	Description
description()	String
operator==( other:UpdateTimer )	Logical
print_to( buffer:PrintWriter )
to<<Object>>()	Boxed<<UpdateTimer>>
to<<String>>()	String
to<<Variant>>()	Variant
type_info()	TypeInfo
update()	(dt:Real,delta_ticks:Int)
update( dt:Real )	(dt:Real,delta_ticks:Int)

Control Library API - brombres/Rogue GitHub Wiki

Action.rogue

class Action

Global Properties

Properties

Methods

ActiveState.rogue

class ActiveState<<$ExtendedType>>

Global Methods

Properties

Methods

EasedValue.rogue

class EasedValue

Properties

class EasedValue<<$DataType>>

Properties

Methods

class TargetValue<<$DataType>>

Properties

Methods

ProgressFn.rogue

class ProgressFn

Global Properties

ProgressState.rogue

class ProgressState<<$ExtendedType>>

Description

Global Methods

Properties

Methods

class ProgressStateYield<<$ExtendedType>>

Properties

Methods

UpdateTimer.rogue

class UpdateTimer [compound]

Global Methods

Properties

Methods

⚠️ GitHub.com Fallback ⚠️

Control Library API - brombres/Rogue GitHub Wiki

Action.rogue

class Action

Global Properties

Properties

Methods

ActiveState.rogue

class ActiveState<<$ExtendedType>>

Global Methods

Properties

Methods

EasedValue.rogue

class EasedValue

Properties

class EasedValue<<$DataType>>

Properties

Methods

class TargetValue<<$DataType>>

Properties

Methods

ProgressFn.rogue

class ProgressFn

Global Properties

ProgressState.rogue

class ProgressState<<$ExtendedType>>

Description

Global Methods

Properties

Methods

class ProgressStateYield<<$ExtendedType>>

Properties

Methods

UpdateTimer.rogue

class UpdateTimer [compound]

Global Methods

Properties

Methods

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️