• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    Vector2

    Represents a 2D vector for positions, velocities, and directions. Unity's Vector2 Documentation

    Properties

    down

    ClientAndServer
    ReadOnly

    A Vector2 pointing downwards. Unity's Vector2.down Documentation

    print(Vector2.down.x) -- 0
    print(Vector2.down.y) -- -1
    

    left

    ClientAndServer
    ReadOnly

    A Vector2 pointing to the left. Unity's Vector2.left Documentation

    print(Vector2.left.x) -- -1
    print(Vector2.left.y) -- 0
    

    magnitude

    number
    ClientAndServer
    ReadOnly

    The length of the Vector2. Unity's Vector2.magnitude Documentation

    local position = Vector2.new(1, 2)
    print(position.magnitude) -- 2.2360679774998
    

    negativeInfinity

    ClientAndServer
    ReadOnly

    A Vector2 with both components at negative infinity. Unity's Vector2.negativeInfinity Documentation

    print(Vector2.negativeInfinity.x) -- -inf
    print(Vector2.negativeInfinity.y) -- -inf
    

    normalized

    ClientAndServer
    ReadOnly

    The normalized version of the Vector2. Unity's Vector2.normalized Documentation

    local position = Vector2.new(1, 2)
    local normalized = position.normalized
    
    print(normalized.x) -- 0.44721359014511
    

    one

    ClientAndServer
    ReadOnly

    A Vector2 with both components set to one. Unity's Vector2.one Documentation

    print(Vector2.one.x) -- 1
    print(Vector2.one.y) -- 1
    

    positiveInfinity

    ClientAndServer
    ReadOnly

    A Vector2 with both components at positive infinity. Unity's Vector2.positiveInfinity Documentation

    print(Vector2.positiveInfinity.x) -- inf
    print(Vector2.positiveInfinity.y) -- inf
    

    A Vector2 pointing to the right. Unity's Vector2.right Documentation

    print(Vector2.right.x) -- 1
    print(Vector2.right.y) -- 0
    

    sqrMagnitude

    number
    ClientAndServer
    ReadOnly

    The square of the Vector2's magnitude. Unity's Vector2.sqrMagnitude Documentation

    local position = Vector2.new(1, 2)
    print(position.sqrMagnitude) -- 5
    

    up

    ClientAndServer
    ReadOnly

    A Vector2 pointing upwards. Unity's Vector2.up Documentation

    print(Vector2.up.x) -- 0
    print(Vector2.up.y) -- 1
    

    x

    number
    ClientAndServer

    The x-component of the Vector2. Unity's Vector2.x Documentation

    local position = Vector2.new(1, 2)
    print(position.x) -- 1
    
    position.x = 3
    print(position.x) -- 3
    

    y

    number
    ClientAndServer

    The y-component of the Vector2. Unity's Vector2.y Documentation

    local position = Vector2.new(1, 2)
    print(position.y) -- 2
    
    position.y = 3
    print(position.y) -- 3
    

    zero

    ClientAndServer
    ReadOnly

    A Vector2 with both components set to zero. Unity's Vector2.zero Documentation

    print(Vector2.zero.x) -- 0
    print(Vector2.zero.y) -- 0
    

    Methods

    Parameters

    Returns

    number

    Parameters

    vector
    maxLength
    number

    Returns

    Parameters

    Returns

    number

    Parameters

    Returns

    number

    Parameters

    other

    Returns

    boolean

    Lerp

    ClientAndServer

    Linearly interpolates between two Vector2's. Unity's Vector2.Lerp Documentation

    local a = Vector2.new(1, 2)
    local b = Vector2.new(3, 4)
    
    local result = Vector2.Lerp(a, b, 0.5)
    print(result.x) -- 2
    print(result.y) -- 3
    

    Parameters

    First Vector2.

    Second Vector2.

    t
    number

    Interpolation factor.

    Returns

    LerpUnclamped

    ClientAndServer

    Linearly interpolates between two Vector2's without clamping 't'. Unity's Vector2.LerpUnclamped Documentation

    local a = Vector2.new(1, 2)
    local b = Vector2.new(3, 4)
    
    local result = Vector2.LerpUnclamped(a, b, 2)
    print(result.x) -- 5
    print(result.y) -- 6
    

    Parameters

    Starting Vector2.

    Ending Vector2.

    t
    number

    Interpolation factor.

    Returns

    Parameters

    Returns

    number

    Parameters

    Returns

    Parameters

    Returns

    MoveTowards

    ClientAndServer

    Moves a Vector2 towards another Vector2 within a maximum distance. Unity's Vector2.MoveTowards Documentation

    local current = Vector2.new(1, 2)
    local target = Vector2.new(3, 4)
    
    local result = Vector2.MoveTowards(current, target, 2)
    print(result.x) -- 3
    print(result.y) -- 4
    

    Parameters

    current

    Current Vector2.

    target

    Target Vector2.

    maxDistanceDelta
    number

    Maximum movement distance.

    Returns

    Normalize

    ClientAndServer

    Converts Vector2 to a direction vector of length 1. Unity's Vector2.Normalize Documentation

    local position = Vector2.new(1, 2)
    position:Normalize()
    
    print(position.x) -- 0.44721359014511
    print(position.y) -- 0.89442718029022
    

    Parameters

    value

    Returns

    Normalize

    ClientAndServer

    Converts Vector2 to a direction vector of length 1. Unity's Vector2.Normalize Documentation

    local position = Vector2.new(1, 2)
    position:Normalize()
    
    print(position.x) -- 0.44721359014511
    print(position.y) -- 0.89442718029022
    

    Returns

    void

    Reflect

    ClientAndServer

    Reflects a Vector2 off a surface Vector2. Unity's Vector2.Reflect Documentation

    local inDirection = Vector2.new(1, 2)
    local surfaceNormal = Vector2.new(0, 1)
    
    local result = Vector2.Reflect(inDirection, surfaceNormal)
    print(result.x) -- 1
    print(result.y) -- -2
    

    Parameters

    inDirection

    Direction of incoming Vector2.

    inNormal

    Returns

    Scale

    ClientAndServer

    Multiplies two Vector2's component-wise. Unity's Vector2.Scale Documentation

    Parameters

    First Vector2.

    Second Vector2.

    Returns

    Scale

    ClientAndServer

    Multiplies two Vector2's component-wise. Unity's Vector2.Scale Documentation

    Parameters

    scale

    Vector2 to scale by.

    Returns

    void

    Set

    ClientAndServer

    Sets the x and y components of the Vector2. Unity's Vector2.Set Documentation

    local position = Vector2.new(1, 2)
    
    position:Set(3, 4)
    print(position.x) -- 3
    print(position.y) -- 4
    

    Parameters

    newX
    number

    New 'x' component.

    newY
    number

    New 'y' component.

    Returns

    void

    Parameters

    Returns

    number

    Parameters

    current
    target
    currentVelocity
    smoothTime
    number

    Parameters

    current
    target
    currentVelocity
    smoothTime
    number
    maxSpeed
    number

    Parameters

    current
    target
    currentVelocity
    smoothTime
    number
    maxSpeed
    number
    deltaTime
    number

    SqrMagnitude

    ClientAndServer

    The square of the Vector2's magnitude. Unity's Vector2.SqrMagnitude Documentation

    local position = Vector2.new(1, 2)
    print(position:SqrMagnitude()) -- 5
    

    Parameters

    Returns

    number

    SqrMagnitude

    ClientAndServer

    The square of the Vector2's magnitude. Unity's Vector2.SqrMagnitude Documentation

    local position = Vector2.new(1, 2)
    print(position:SqrMagnitude()) -- 5
    

    Returns

    number

    Updated 9 days ago

    PocketWorlds Icon

    © 2025 Pocket Worlds. All rights reserved.