Skip to content
Contribute

void Obj::Progress(int)

Progress · Obj

Family: Obj

void Obj::Progress(int)

Requests a script wait associated with an object's command progress, using the supplied duration. This overload uses the integer argument in the script wait counter and records the progress start and end times.

Training and research scripts commonly obtain the duration from cmddelay, sometimes adjusting it by a percentage. The argument's relationship to real-time units and the details of script resumption are not fully documented.

Return type: void

The member is called on an object. Its receiver is not repeated among this signature’s arguments.

Position Type
1 int

Check the exact signature. A description of one overload does not automatically document the others.

Keep the notes and limitations when reusing this description. Do not infer undocumented parameter meanings, units or effects.

Suggest a better description

Write how you would explain this entry. Your proposal will be held in a private inbox for review.

0 / 4000

Proposals are not published automatically. Do not include personal information in your description.