Home › Engine Lua tables › ForgeUI control types › AnimControl

Engine executable. Settings and tools of the game program (CivilizationVI.exe), usable without a mod. Mostly undocumented debug and configuration functionality; descriptions come from analysis of the executable and have not all been tried in the running game.

AnimControl

ForgeUI control type (ForgeUI::AnimControl). 28 methods, called on an instance with a colon: Controls.SomeName:Method(...).

C++ base classes (from the exe RTTI, see engine classes): ForgeUI::ControlBase. Whether the Lua type also exposes the base class methods was not checked; the methods below are those registered on this type itself.

Method	C++ signature printed by the exe	Lua signature	Owner basis
`ClearAnimCallback`	`void ClearAnimCallback( void )`	`AnimControl:ClearAnimCallback()`	unique method name
`ClearEndCallback`	`void ClearEndCallback( void )`	`AnimControl:ClearEndCallback()`	unique method name
`ClearStartCallback`	`void ClearStartCallback( void )`	`AnimControl:ClearStartCallback()`	unique method name
`GetCycleType`	`int GetCycleType( void )`	`AnimControl:GetCycleType() -> integer`	unique method name
`GetPauseTime`	`float GetPauseTime( void )`	`AnimControl:GetPauseTime() -> number`	unique method name
`GetProgress`	`float GetProgress( void )`	`AnimControl:GetProgress() -> number`	unique method name
`GetVoid1`	`int GetVoid1( void ) const`	`AnimControl:GetVoid1() -> integer`	neighbouring methods in the code
`GetVoid2`	`int GetVoid2( void ) const`	`AnimControl:GetVoid2() -> integer`	neighbouring methods in the code
`IncrementPause`	`void IncrementPause( float )`	`AnimControl:IncrementPause(arg1: number)`	unique method name
`IsInPause`	`bool IsInPause( void )`	`AnimControl:IsInPause() -> boolean`	unique method name
`IsReversing`	`bool IsReversing( void )`	`AnimControl:IsReversing() -> boolean`	unique method name
`IsStopped`	`bool IsStopped( void )`	`AnimControl:IsStopped() -> boolean`	unique method name
`Play`	`void Play( void )`	`AnimControl:Play()`	neighbouring methods in the code
`RegisterAnimCallback`	`void RegisterAnimCallback( function )`	`AnimControl:RegisterAnimCallback(arg1: function)`	unique method name
`RegisterEndCallback`	`void RegisterEndCallback( function )`	`AnimControl:RegisterEndCallback(arg1: function)`	neighbouring methods in the code
`RegisterStartCallback`	`void RegisterStartCallback( function )`	`AnimControl:RegisterStartCallback(arg1: function)`	unique method name
`Reverse`	`void Reverse( void )`	`AnimControl:Reverse()`	unique method name
`SetCycleType`	—	`AnimControl:SetCycleType()`	unique method name
`SetEndPauseTime`	`void SetEndPauseTime( float )`	`AnimControl:SetEndPauseTime(arg1: number)`	unique method name
`SetPauseTime`	`void SetPauseTime( float )`	`AnimControl:SetPauseTime(arg1: number)`	unique method name
`SetProgress`	`void SetProgress( float )`	`AnimControl:SetProgress(arg1: number)`	unique method name
`SetSpeed`	`void SetSpeed( float )`	`AnimControl:SetSpeed(arg1: number)`	unique method name
`SetToBeginning`	`void SetToBeginning( void )`	`AnimControl:SetToBeginning()`	unique method name
`SetToEnd`	—	`AnimControl:SetToEnd()`	unique method name
`SetVoid1`	`void SetVoid1( int )`	`AnimControl:SetVoid1(arg1: integer)`	neighbouring methods in the code
`SetVoid2`	`void SetVoid2( int )`	`AnimControl:SetVoid2(arg1: integer)`	neighbouring methods in the code
`SetVoids`	`void SetVoids( int, int )`	`AnimControl:SetVoids(arg1: integer, arg2: integer)`	neighbouring methods in the code
`Stop`	`void Stop( void )`	`AnimControl:Stop()`	neighbouring methods in the code