Primitive Class Flow.Starfield

Represents a starfield in the sky.

Functions

Starfield(starCount) Create a starfield object with only stars.
Starfield(starCount, meteorCount) Create a starfield object with stars and meteors.
Starfield:GetStarCount() Get this starfield's number of stars.
Starfield:GetMeteorCount() Get this starfield's number of meteors.
Starfield:GetMeteorSpawnDensity() Get this starfield's meteor spawn density.
Starfield:GetMeteorVelocity() Get this starfield's meteor velocity.
Starfield:GetStarsEnabled() Get this starfield's stars enabled status.
Starfield:GetMeteorsEnabled() Get this starfield's meteors enabled status.
Starfield:SetStarCount(New) Set this starfield's number of stars.
Starfield:SetMeteorCount(New) Set this starfield's number of meteors.
Starfield:SetMeteorSpawnDensity(New) Set this starfield's meteor spawn density.
Starfield:SetMeteorVelocity(New) Set this starfield's meteor velocity.


Functions

Starfield(starCount)
Create a starfield object with only stars.

Parameters:

  • starCount int Star count.

Returns:

    Starfield A new Starfield object.
Starfield(starCount, meteorCount)
Create a starfield object with stars and meteors.

Parameters:

  • starCount int Star count. Max: 6000
  • meteorCount int Meteor count. Max: 100

Returns:

    Starfield A new Starfield object.
Starfield:GetStarCount()
Get this starfield's number of stars.

Returns:

    int Count.
Starfield:GetMeteorCount()
Get this starfield's number of meteors.

Returns:

    int Count.
Starfield:GetMeteorSpawnDensity()
Get this starfield's meteor spawn density.

Returns:

    int Spawn density.
Starfield:GetMeteorVelocity()
Get this starfield's meteor velocity.

Returns:

    float Velocity.
Starfield:GetStarsEnabled()
Get this starfield's stars enabled status.

Returns:

    bool Stars enabled status. true: enabled, false: disabled
Starfield:GetMeteorsEnabled()
Get this starfield's meteors enabled status.

Returns:

    bool Meteors enabled status. true: enabled, false: disabled
Starfield:SetStarCount(New)
Set this starfield's number of stars.

Parameters:

  • New int star count.
Starfield:SetMeteorCount(New)
Set this starfield's number of meteors.

Parameters:

  • New int meteor count.
Starfield:SetMeteorSpawnDensity(New)
Set this starfield's meteor spawn density.

Parameters:

  • New int meteor spawn density.
Starfield:SetMeteorVelocity(New)
Set this starfield's meteor velocity.

Parameters:

  • New float meteor velocity.
generated by TEN-LDoc (a fork of LDoc 1.4.6)