Class: Table
Overview
Class that store a 3D array of value coded with 16bits (signed)
Instance Attribute Summary collapse
-
#dim ⇒ Integer
readonly
Dimension of the table (1D, 2D, 3D).
-
#xsize ⇒ Integer
readonly
Number of row in the table.
-
#ysize ⇒ Integer
readonly
Number of cols in the table.
-
#zsize ⇒ Integer
readonly
Number of 2D table in the table.
Instance Method Summary collapse
-
#[](x, y = 0, z = 0) ⇒ Integer?
Access to a value of the table.
-
#[]=(x, y, z, value)
Change a value in the table.
-
#copy(table, dest_offset_x, dest_offset_y) ⇒ Boolean
Copy another table to this table.
-
#copy_modulo(table, source_origin_x, source_origin_y, dest_offset_x, dest_offset_y, width, height)
Copy another table to a specified surface of the current table using a circular copy (dest_coord = offset + source_coord % source_size).
-
#fill(value)
Fill the whole table with a specific value.
-
#initialize(xsize, ysize = 1, zsize = 1) ⇒ Table
constructor
Create a new table without pre-initialization of the contents.
-
#resize(xsize, ysize = 1, zsize = 1)
Resize the table.
Constructor Details
#initialize(xsize, ysize = 1, zsize = 1) ⇒ Table
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
1290 1291 1292 |
# File 'LiteRGSS.rb.yard.rb', line 1290 def initialize(xsize, ysize = 1, zsize = 1) end |
Instance Attribute Details
#dim ⇒ Integer (readonly)
Returns Dimension of the table (1D, 2D, 3D).
1329 1330 1331 |
# File 'LiteRGSS.rb.yard.rb', line 1329 def dim @dim end |
#xsize ⇒ Integer (readonly)
Returns number of row in the table.
1323 1324 1325 |
# File 'LiteRGSS.rb.yard.rb', line 1323 def xsize @xsize end |
#ysize ⇒ Integer (readonly)
Returns number of cols in the table.
1325 1326 1327 |
# File 'LiteRGSS.rb.yard.rb', line 1325 def ysize @ysize end |
#zsize ⇒ Integer (readonly)
Returns number of 2D table in the table.
1327 1328 1329 |
# File 'LiteRGSS.rb.yard.rb', line 1327 def zsize @zsize end |
Instance Method Details
#[](x, y = 0, z = 0) ⇒ Integer?
Access to a value of the table
1298 1299 1300 |
# File 'LiteRGSS.rb.yard.rb', line 1298 def [](x, y = 0, z = 0) end |
#[]=(x, y, z, value)
Change a value in the table
1304 1305 1306 |
# File 'LiteRGSS.rb.yard.rb', line 1304 def []=(x, value) end |
#copy(table, dest_offset_x, dest_offset_y) ⇒ Boolean
If any parameter is invalid (eg. dest_offset_coord < 0) the function does nothing.
Copy another table to this table
1349 1350 1351 |
# File 'LiteRGSS.rb.yard.rb', line 1349 def copy(table, dest_offset_x, dest_offset_y) end |
#copy_modulo(table, source_origin_x, source_origin_y, dest_offset_x, dest_offset_y, width, height)
Copy another table to a specified surface of the current table using a circular copy (dest_coord = offset + source_coord % source_size)
1360 1361 1362 |
# File 'LiteRGSS.rb.yard.rb', line 1360 def copy_modulo(table, source_origin_x, source_origin_y, dest_offset_x, dest_offset_y, width, height) end |
#fill(value)
Fill the whole table with a specific value
1340 1341 1342 |
# File 'LiteRGSS.rb.yard.rb', line 1340 def fill(value) end |
#resize(xsize, ysize = 1, zsize = 1)
Some value may be undeterminated if the new size is bigger than the old size
Resize the table
1335 1336 1337 |
# File 'LiteRGSS.rb.yard.rb', line 1335 def resize(xsize, ysize = 1, zsize = 1) end |