GetSpriteLocalSize
Size = GetSpriteLocalSize(SpriteNumber)
 
Parameters:

    SpriteNumber = The Index of the sprite you wish to query
Returns:

    Size = The size in bytes of this sprites local data area
 

      The GetSpriteLocalSize function returns the size of the sprites local data area.



FACTS:


      * It will return a false(0) if no local buffer exists

      * See CreateSpriteLocals





Mini Tutorial:


      This example creates a sprites local data bank, fills it will various tidbits of test data, then reads this data back from the sprite.


  
; Create a Sprite
  CreateSprite 1
  
; Attach a Local data area, 100 bytes long To this sprite
  CreateSpriteLocals 1,100
  
  Print "Size:"+Str$(GetSpriteLocalSize(1))
  
; Display the screen and wait for a key press
  Sync
  WaitKey
  
  



This example would output.
  
  Size:100
  


 
Related Info: CreateSpriteLocals | DeleteSpriteLocals | GetSpriteLocalByte | GetSpriteLocalFloat | GetSpriteLocalInt | GetSpriteLocalString | GetSpriteLocalWord | SpriteLocalByte | SpriteLocalFloat | SpriteLocalInt | SpriteLocalString | SpriteLocalWord :
 


(c) Copyright 2002 - 2024 - Kevin Picone - PlayBASIC.com