quad/src/types.lua

335 lines
10 KiB
Lua

-------------------
-- module_class
-------------------
export type extend = {
Getter: {[string]: ()->(any?)?};
Setter: {[string]: (value:any)->()?};
New: (prop:DOM_constructor)->DOM|any;
Init: (self:extend,props:valueStore)->();
Render: (self:extend,props:valueStore)->(DOM|any);
AfterRender: (self:extend,item:DOM|any,props:valueStore)->();
GetPropertyChangedSignal: (self:extend,propertyName:string)->signal;
EmitPropertyChangedSignal: (self:extend,propertyName:string,...any)->();
Update: (self:extend)->();
Destroy: (self:extend)->();
UpdateTriggers: {[string]:boolean?};
}
export type DOM = {
[string]: any;
Destroy: (self:DOM)->();
GetPropertyChangedSignal: (self:DOM,propertyName:string)->(RBXScriptSignal|signal);
Update: (self:DOM)->();
}
export type DOM_constructor = {
[event]:
(DOM,...any)->()
&{self: any,func: (...any)->(...any)};
} & { [number]: DOM|style; }
& { [string]: any|register; }
export type DOM_creator = (DOM_constructor,...DOM_constructor)->DOM
export type imported =
{[string]:any}
&(ids:ObjectIdList)->DOM_creator
&DOM_creator
export type import = (ClassName:string|ModuleScript|extend|()->()|{any},defaultProperties:DOM_constructor?)->imported
export type module_class = {
Extend: ()->extend;
Import: import;
GetProperty: (item:extend|any,index:string,ClassName:string?)->any;
SetProperty: (item:extend|any,index:string,value:any,ClassName:string?)->();
Make: (ClassName:string|(...any)->any|extend,...{any})->any;
} & import
-------------------
-- module_event
-------------------
export type event = string
export type module_event = {
Prop: (propName:string)->event;
CreatedAsync: event;
Created: event;
Bind: (this:DOM|any,key:event|string,func:(...any)->(),typefunc:string?)->();
} & (eventName:string)->event;
-------------------
-- module_signal
-------------------
export type connection = {
Disconnect: (self:connection)->();
Destroy: (self:connection)->();
New: (signal,(...any)->())->();
}
export type signal = {
Fire: (self:signal,...any)->();
Wait: (self:signal)->();
CheckConnected: (self:signal,(...any)->())->boolean;
Connect: (self:signal,(...any)->())->connection;
Once: (self:signal,(...any)->())->connection;
Destroy: (self:signal)->();
New: (id:string?)->signal;
}
export type disconnecter = {
Add: (self:disconnecter,connection:RBXScriptConnection)->();
Destroy: (self:disconnecter)->();
Disconnect: (self:disconnecter)->();
New: (id:string?)->disconnecter;
}
export type module_signal = {
Disconnecter: disconnecter;
Bindable: signal;
}
-------------------
-- module_register
-------------------
export type register = {
Register: (self:register,()->())->();
With: <R>(self:R&register,handler:{any}|(store:valueStore,value:any,key:any,item:DOM)->any)->R&register;
Default: <R>(self:R&register,value:any)->R&register;
Add: <R>(self:R&register,value:any)->R&register;
Tween: <R>(self:R&register,tween:TweenOptions)->R&register;
}
export type valueStore = {[any]:any}&(key:string)->register
export type objectList = {
Each: (self:objectList,(item:DOM|any,index:number)->())->();
EachSync: (self:objectList,(item:DOM|any,index:number)->())->();
Remove: (self:objectList,index:number|DOM)->(DOM?,number?);
IsEmpty: (self:objectList)->boolean;
}
export type ObjectIdList = string
export type module_store = {
GetObjects: (ids:ObjectIdList)->objectList;
GetObject: (id:string)->DOM?;
AddObject: (ids:ObjectIdList)->();
GetStore: (id:string?)->valueStore;
} & (id:string?)->valueStore
-------------------
-- module_style
-------------------
export type style = {}
export type module_style = {
New: (props:{[string]:any})->style;
} & (props:{[string]:any})->style
-------------------
-- module_mount
-------------------
export type mount = {
Unmount: (self:mount)->();
}
export type mounts = mount & {
Add: (self:mount,...DOM|any)->();
}
export type module_mount = {
MountOne: (to:DOM|any,object:DOM|any,holder:DOM|any?)->mount;
GetHolder: (item:DOM|any)->any?;
} & (to:DOM|any,object:DOM|any,holder:DOM|any?)->mounts
-------------------
-- module_tween
-------------------
export type TweenOnStepped = (Item:DOM|any,Alpha:number,AbsolutePercent:number)->()
export type TweenEnded = (Item:DOM|any)->()
export type TweenSetter = (Item:DOM|any,Property:string,Value:Lerpable)->()
export type TweenGetter = (Item:DOM|any,Property:string)->()
export type TweenOptions = {
Easing: "Linear"
|"Quint"
|"Quart"
|"Cubic"
|"Quad"
|"Sin"
|"Circle"
|"Expo"
|"Elastic"
|"Bounce"
|"Exp2"
|"Exp4"
|EasingFunction?;
Direction: "Out"|"InOut"|"In"|EasingDirection?;
CallBack: {[number|"*"|string]:(Item:DOM|any,Alpha:number,AbsolutePercent:number)->()}?;
OnStepped: TweenOnStepped?; -- Same as CallBack{["*"]:()->()} But faster then CallBack due to table loop
Ended: TweenEnded?;
Getter: TweenGetter?;
Setter: TweenSetter?;
Time: number?;
}
export type EasingFunction = {run:(number)->number,[any]:any}
export type EasingFunctions = {
Linear: EasingFunction; ---직선, Linear. i=x, x=0 ~ 1
Quint: EasingFunction; ---5제곱, Quint. (^5) i=1-(1-x)^5, x=0 ~ 1
Quart: EasingFunction; ---4제곱, Quart. (^4) i=1-(1-x)^4, x=0 ~ 1
Cubic: EasingFunction; ---3제곱, Cubic. (^3) i=1-(1-x)^3, x=0 ~ 1
Quad: EasingFunction; ---2제곱, Quad. (^2) i=1-(1-x)^2, x=0 ~ 1
Sin: EasingFunction; ---사인파, Sin. i=sin(x*pi/2), x=0 ~ 1
Circle: EasingFunction; ---사분원, Circle. i=sqrt(1-(1-x)^2), x=0 ~ 1
Expo: EasingFunction; ---지수함수, Expo. i=1-2^(-10*x), x=0~1
Elastic: EasingFunction; ---튀어오름, Elastic.
Bounce: EasingFunction; ---통통거림, Bounce
-- Old things
Exp2: EasingFunction; ---덜 가파른 지수. i=math.exp(x), x=-4 ~ 2
Exp4: EasingFunction; ---더 가파른 지수. i=math.exp(x), x=-4 ~ 4
}
export type EasingDirection = string
export type EasingDirections = {
Out: EasingDirection&"Out";
In: EasingDirection&"In";
InOut: EasingDirection&"InOut";
}
export type Lerpable = Color3|UDim|UDim2|number|Vector2|Vector3|CFrame
export type TweenHandler = ()->();
export type module_tween = {
EasingFunctions:EasingFunctions;
EasingDirections:EasingDirections;
LerpProperties: <item>(item:item&(DOM|any),old:{[string]:Lerpable},new:{[string]:Lerpable},alpha:number,setter:(item:item&(DOM|any),property:string,value:Lerpable)->()?)->();
RunTween: (Item:DOM|any,Option:TweenOptions,Properties:{[string]:Lerpable},Ended:TweenEnded?,OnStepped:TweenOnStepped?,Setter:TweenSetter?,Getter:TweenGetter?)->TweenHandler;
RunTweens: (Items:{[number]:DOM|any},Option:TweenOptions,Properties:{[string]:Lerpable},Ended:TweenEnded?,OnStepped:TweenOnStepped?,Setter:TweenSetter?,Getter:TweenGetter?)->();
StopTween: (ItemOrStep:TweenHandler|DOM|any)->();
StopPropertyTween: (Item:DOM|any,PropertyName:string)->();
IsTweening: (ItemOrStep:TweenHandler|DOM|any)->boolean;
IsPropertyTweening: (Item:DOM|any,PropertyName:string)->boolean;
}
-------------------
-- module_round
-------------------
export type module_round = {
SetRound: (ImageFrame:ImageLabel|ImageButton,RoundSize:number)->(ImageLabel|ImageButton);
SetOutline: (ImageFrame:ImageLabel|ImageButton,RoundSize:number)->(ImageLabel|ImageButton);
GetRound: (ImageFrame:ImageLabel|ImageButton)->number;
GetOutline: (ImageFrame:ImageLabel|ImageButton)->number;
}
-------------------
-- module_signal
-------------------
export type langOptions = {
[string]: register|string|number|any;
}
export type langHandler = {
[string]: string|(langOptions:langOptions)->string;
}
export type Locale = string
export type module_lang = {
New: (id:string,handlers:{
en_us: langHandler;
es_es: langHandler;
fr_fr: langHandler;
id_id: langHandler;
it_it: langHandler;
ja_jp: langHandler;
ko_kr: langHandler;
ru_ru: langHandler;
th_th: langHandler;
tr_tr: langHandler;
vi_vn: langHandler;
pt_br: langHandler;
de_de: langHandler;
zh_cn: langHandler;
zh_tw: langHandler;
bg_bg: langHandler;
bn_bd: langHandler;
cs_cz: langHandler;
da_dk: langHandler;
el_gr: langHandler;
et_ee: langHandler;
fi_fi: langHandler;
hi_in: langHandler;
hr_hr: langHandler;
hu_hu: langHandler;
ka_ge: langHandler;
kk_kz: langHandler;
km_kh: langHandler;
lt_lt: langHandler;
lv_lv: langHandler;
ms_my: langHandler;
my_mm: langHandler;
nb_no: langHandler;
nl_nl: langHandler;
fil_ph: langHandler;
pl_pl: langHandler;
ro_ro: langHandler;
uk_ua: langHandler;
si_lk: langHandler;
sk_sk: langHandler;
sl_sl: langHandler;
sq_al: langHandler;
bs_ba: langHandler;
sr_rs: langHandler;
sv_se: langHandler;
ar_001: langHandler;
})->();
Locales: {
English: Locale & "en_us";
Spanish: Locale & "es_es";
French: Locale & "fr_fr";
Indonesian: Locale & "id_id";
Italian: Locale & "it_it";
Japanese: Locale & "ja_jp";
Korean: Locale & "ko_kr";
Russian: Locale & "ru_ru";
Thai: Locale & "th_th";
Turkish: Locale & "tr_tr";
Vietnamese: Locale & "vi_vn";
Portuguese: Locale & "pt_br";
German: Locale & "de_de";
ChineseSimplified: Locale & "zh_cn";
ChineseTraditional: Locale & "zh_tw";
Bulgarian: Locale & "bg_bg";
Bengali: Locale & "bn_bd";
Czech: Locale & "cs_cz";
Danish: Locale & "da_dk";
Greek: Locale & "el_gr";
Estonian: Locale & "et_ee";
Finnish: Locale & "fi_fi";
Hindi: Locale & "hi_in";
Croatian: Locale & "hr_hr";
Hungarian: Locale & "hu_hu";
Georgian: Locale & "ka_ge";
Kazakh: Locale & "kk_kz";
Khmer: Locale & "km_kh";
Lithuanian: Locale & "lt_lt";
Latvian: Locale & "lv_lv";
Malay: Locale & "ms_my";
Burmese: Locale & "my_mm";
Bokmal: Locale & "nb_no";
Dutch: Locale & "nl_nl";
Filipino: Locale & "fil_ph";
Polish: Locale & "pl_pl";
Romanian: Locale & "ro_ro";
Ukrainian: Locale & "uk_ua";
Sinhala: Locale & "si_lk";
Slovak: Locale & "sk_sk";
Slovenian: Locale & "sl_sl";
Albanian: Locale & "sq_al";
Bosnian: Locale & "bs_ba";
Serbian: Locale & "sr_rs";
Swedish: Locale & "sv_se";
Arabic: Locale & "ar_001";
};
Lang: Locale;
Default: Locale;
} & (id:string)->(langOptions)->register;
-------------------
-- module
-------------------
export type module_exported = {
Signal: module_signal;
Round: module_round;
Tween: module_tween;
Style: module_style;
Event: module_event;
Store: module_store;
Mount: module_mount;
Class: module_class;
Lang: module_lang;
}
export type module = {
Uninit: (QuadId:string)->();
Init: (QuadId:string?)->module_exported;
}
return {}