Class: Table32

Inherits:
Object show all
Defined in:
LiteRGSS.rb.yard.rb

Overview

Class that store a 3D array of value coded with 32bits (signed)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#dim ⇒ Integer (readonly)

Returns Dimension of the table (1D, 2D, 3D).

Returns:

  • (Integer) —

    Dimension of the table (1D, 2D, 3D)



1403
1404
1405
 
# File 'LiteRGSS.rb.yard.rb', line 1403

def dim
  @dim
end

#xsize ⇒ Integer (readonly)

Returns number of row in the table.

Returns:

  • (Integer) —

    number of row in the table



1397
1398
1399
 
# File 'LiteRGSS.rb.yard.rb', line 1397

def xsize
  @xsize
end

#ysize ⇒ Integer (readonly)

Returns number of cols in the table.

Returns:

  • (Integer) —

    number of cols in the table



1399
1400
1401
 
# File 'LiteRGSS.rb.yard.rb', line 1399

def ysize
  @ysize
end

#zsize ⇒ Integer (readonly)

Returns number of 2D table in the table.

Returns:

  • (Integer) —

    number of 2D table in the table



1401
1402
1403
 
# File 'LiteRGSS.rb.yard.rb', line 1401

def zsize
  @zsize
end

Class Method Details

.new(xsize, ysize = 1, zsize = 1)

Note:

Never call initialize from the Ruby code other than using Table.new. It’ll create memory if you call initialize from Ruby, use #resize instead.

Create a new table without pre-initialization of the contents

Parameters:

  • xsize (Integer) —

    number of row

  • ysize (Integer) (defaults to: 1) —

    number of cols

  • zsize (Integer) (defaults to: 1) —

    number of 2D table



1364
1365
1366
 
# File 'LiteRGSS.rb.yard.rb', line 1364

def self.new(xsize, ysize = 1, zsize = 1)

end

Instance Method Details

#[](x, y = 0, z = 0) ⇒ Integer?

Access to a value of the table

Parameters:

  • x (Integer) —

    index of the row

  • y (Integer) (defaults to: 0) —

    index of the col

  • z (Integer) (defaults to: 0) —

    index of the 2D table

Returns:

  • (Integer, nil) —

    nil if x, y or z are outside of the table.



1372
1373
1374
 
# File 'LiteRGSS.rb.yard.rb', line 1372

def [](x, y = 0, z = 0)

end

#[]=(x, y, z, value)

Change a value in the table

Parameters:

  • x (Integer) —

    row index of the cell to affect to the new value

  • y (Integer) —

    col index of the cell to affect to the new value

  • z (Integer) —

    index of the table containing the cell to affect to the new value

  • value (Integer) —

    new value



1378
1379
1380
 
# File 'LiteRGSS.rb.yard.rb', line 1378

def []=(x, value)

end

#fill(value)

Fill the whole table with a specific value

Parameters:

  • value (Integer) —

    the value to affect to every cell of the table



1414
1415
1416
 
# File 'LiteRGSS.rb.yard.rb', line 1414

def fill(value)

end

#resize(xsize, ysize = 1, zsize = 1)

Note:

Some value may be undeterminated if the new size is bigger than the old size

Resize the table

Parameters:

  • xsize (Integer) —

    number of row

  • ysize (Integer) (defaults to: 1) —

    number of cols

  • zsize (Integer) (defaults to: 1) —

    number of 2D table



1409
1410
1411
 
# File 'LiteRGSS.rb.yard.rb', line 1409

def resize(xsize, ysize = 1, zsize = 1)

end