Range

Inherits: Class

Methods

Contains

function Range:Contains(other)
  -> boolean

Returns whether or not the range completely contains another range.

Parameters:

Name	Type	Description
other	Range	The other range

Returns:

Type	Description
boolean

GetEnd

function Range:GetEnd()
  -> number

Gets the end value of the range.

Returns:

Type	Description
number

GetLength

function Range:GetLength()
  -> number

Gets the length of the range.

Returns:

Type	Description
number

GetStart

function Range:GetStart()
  -> number

Gets the start value of the range.

Returns:

Type	Description
number

GetValues

function Range:GetValues()
  -> number, number

Gets the start and end values of a range.

Returns:

Name	Type	Description
startValue	number
endValue	number

Includes

function Range:Includes(value)
  -> boolean

Returns whether or not the range includes a value.

Parameters:

Name	Type	Description
value	number	The value to check

Returns:

Type	Description
boolean

IntersectionLength

function Range:IntersectionLength(other)
  -> number

Returns the length of the intersection with another range or 0 if they don't intersect.

Parameters:

Name	Type	Description
other	Range	The other range

Returns:

Type	Description
number

Iterator

function Range:Iterator()
  -> fun():number, number, number

Iterates over the integer values in the range.

Returns:

Type	Description
fun():number	Iterator with fields: value
number
number

Release

function Range:Release()

Releases the range object.

SetStartEnd

function Range:SetStartEnd(startValue, endValue)
  -> self

Sets the start value and end value of the range.

Parameters:

Name	Type	Description
startValue	number	The start value of the range
endValue	number	The end value of the range

Returns:

Type	Description
self

SetStartLength

function Range:SetStartLength(startValue, length)
  -> self

Sets the start value and length of the range.

Parameters:

Name	Type	Description
startValue	number	The start value of the range
length	number	The length of the range

Returns:

Type	Description
self

StartsBefore

function Range:StartsBefore(other)
  -> boolean

Returns whether or not the range starts before another range.

Parameters:

Name	Type	Description
other	Range	The other range

Returns:

Type	Description
boolean

__tostring

function Range:__tostring()

Functions

AcquireStartEnd

function Range.AcquireStartEnd(startValue, endValue)
  -> Range

Acquires a range object for a given start and end value.

Parameters:

Name	Type	Description
startValue	number	The start value of the range
endValue	number	The end value of the range

Returns:

Type	Description
Range

AcquireStartLength

function Range.AcquireStartLength(startValue, length)
  -> Range

Acquires a range object from a given start value and length.

Parameters:

Name	Type	Description
startValue	number	The start value of the range
length	number	The length of the range

Returns:

Type	Description
Range

StaticStartEnd

function Range.StaticStartEnd(startValue, endValue)
  -> Range

Acquires a static range object (can't be released or mutated) for a given start and end value.

Parameters:

Name	Type	Description
startValue	number	The start value of the range
endValue	number	The end value of the range

Returns:

Type	Description
Range