Code

###
# Group = 0x7FD46CD0, Instance = 0x118
# Title = Idle
#
# Format = 8009, Params = 1, Locals = 0
# Tree type = 0, Header flag = 0, Tree version = 2 (2), Cache flags = 0

    0: Sleep: for Param 0 ticks; true: true, false: error

Purpose

This is one of three Idle functions that are extremely useful in the Main Function of objects. They are used to cause the object to idle, or pause, for a period of time before moving on to the next line of code.

When you use the normal Idle global function, you feed a numerical argument that tells the object how many ticks to pause for. 30 ticks equals one Sim minute, 1800 ticks equals one Sim hour, and so on. In order to save you from having to think, however, there are two other global functions to help with this conversion: Idle - Minutes and Idle - Hours.

Usage

When you call this BHAV, provide the literal number of ticks that you want the object to pause for. Remember that 30 ticks equal one Sim minute. So, for example, if you want the object to idle for 1 Sim minute, feed in this:

07 1E 00 00 00 00 00 00
00 00 00 00 01 00 00 00

Which should yield this from SimPE's BHAV editor:

[global 0x0118] Idle (1 arg: Literal 0x001E)

For more information on how this works, refer to this page: Using BHAVs With Arguments.

Examples

You can see the various idle functions in nearly all Main Functions of objects.