game.swapDefaultUserAIModels

Swaps the position of 2 User AI Models.

Prototype

  1. bOk = game.swapDefaultUserAIModels ( hGame, nIndex1, nIndex2 )

Description

AIs in the User AI stack get interpreted from top (index 1) to bottom, so the position these AIModels are in can be important.

Parameters

hGame - valid Game handle
nIndex1 - index number 1, 1..nAIModelCount
nIndex2 - index number 2, 1..nAIModelCount

Return values

bOk - true on success

Sample

  1. local nSwappedItemIndex = nSelectedItemIndex + ( bUp and -1 or 1 )
  2. local hSwappedItem = gui.getTreeItem ( hTree, nSwappedItemIndex )
  3.  
  4. game.swapDefaultUserAIModels ( hGame, nSelectedItemIndex, nSwappedItemIndex )

Available since ShiVa 2.0