Gammon Forum

'
'  See if memberName is in listName
'
'  eg.  if IsMember ("spell_list", "fiery blast") then
'          ... do something ...
'
'

Function IsMember (listName, memberName)
dim ListContents
dim theList
dim WantedMember
dim i

' Default to not found
IsMember = False

' Fix up member to remove surrounding spaces and make lower case
WantedMember = Trim (LCase (memberName))

' Can't find blank items
If WantedMember = "" Then
  Exit Function
End If

' Get list
ListContents = World.GetVariable (listName)

' If no list, the member can't be in it
If IsEmpty (ListContents) or IsNull (ListContents) then
  Exit Function
End If

' Split list at commas
theList = split (ListContents, ",")

' Loop through list, seeing if wanted member is in it
If Not IsEmpty (theList) then
  For i = lbound (theList) to ubound (theList)
  If theList (i) = WantedMember then
    IsMember = True
    Exit Function
  End If      ' end of found it
  Next        ' end of loop
End If        ' end of any items in list

End Function

'
'  Add memberName to listName
'
'  eg.  AddItem  "spell_list", "fiery blast"
'
'  Note - it is up to you to test if the item is already
'         in the list (using IsMember) or it will be added 
'         twice.
'
'

Sub AddItem (listName, memberName)
dim ListContents
dim theList
dim NewMember
dim i

' Get existing list
ListContents = World.GetVariable (listName)

' Make sure new member is lower case with no spaces around it
NewMember = Trim (LCase (memberName))

' Don't add blank items
If NewMember = "" Then
   Exit Sub
End If

' Need comma after previous member, if any
If ListContents <> "" Then
  ListContents = ListContents & ","
End If
 
' Add new item
ListContents = ListContents & NewMember

World.SetVariable listName, ListContents

End Sub

'
'  Delete memberName from listName
'
'  eg. DeleteItem "spell_list", "fiery blast"
'
'

Sub DeleteItem (listName, memberName)
dim ListContents
dim theList
dim WantedMember
dim i
dim NewContents

' Fix up member to remove surrounding spaces and make lower case
WantedMember = Trim (LCase (memberName))

' Can't delete blank items
If WantedMember = "" Then
  Exit Sub
End If

' Get list
ListContents = World.GetVariable (listName)

' If no list, the member can't be in it
If IsEmpty (ListContents) or IsNull (ListContents) then
  Exit Sub
End If

' Split list at commas
theList = split (ListContents, ",")

' New contents are empty now
NewContents = ""

' Loop through list, copying across all but delete item
If Not IsEmpty (theList) then
  For i = lbound (theList) to ubound (theList)
  If theList (i) <> WantedMember then
    If NewContents <> "" Then
       NewContents = NewContents & ","
    End If
  NewContents = NewContents & theList (i)
  End If      ' end of not deleted item
  Next        ' end of loop
End If        ' end of any items in list

' Store new list contents
World.SetVariable listName, NewContents

End Sub


'
'  Delete the entire list called listName
'
'  eg. DeleteList "spell_list"
'
'
Sub DeleteList (listName)

World.DeleteVariable listName

End Sub