Regular API function

simRemoveBanner

Description Removes a previously added banner. See also simAddBanner
C synopsis simInt simRemoveBanner(simInt bannerID)
C parameters
bannerID: handle of a previously added banner. sim_handle_all removes all banners from the scene. If you or-combine the bannerID with sim_handleflag_togglevisibility, then you can toggle the banner's visibility without removing it: in that case, the return value is the new visibility stae of the banner.
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis number result=simRemoveBanner(number bannerID)
Lua parameters
bannerID: handle of a previously added banner. sim_handle_all removes all banners from the scene, that were created in a script (banners created from the C interface are not removed)
Lua return values
Same as C-function

All regular API functions on one page