game.removeDefaultUserAIModel

Removes an AIModel from the "User AI" stack.

Prototype

  1. bOk = game.removeDefaultUserAIModel ( hGame, hFile|sAIModelName )

Description

Removes an AIModel with the string sAIModelName from the "User AI" stack.


Parameters

hGame - valid Game handle
hFile|sAIModelName - valid file handle OR AImodel string name


Return values

bOk - true on success


Sample

  1. -- Remove items
  2. for nSelectedItem = 1, gui.getTreeSelectedItemCount ( hTree ) do
  3. local hSelectedItem = gui.getTreeSelectedItem ( hTree, nSelectedItem )
  4. local sSelectedItemName = gui.getTreeItemData ( hSelectedItem, gui.kDataRoleUser + 1 )
  5. game.removeDefaultUserAIModel ( hGame, sSelectedItemName )
  6. end

Available since ShiVa 2.0