parallax_render_source

Parallax render sources are screens that hold the appearance data for a specific type of parallax layer; this appearance is then drawn to client parallax layers using render targets and sources. This permits the appearance of a specific parallax layer to be edited at runtime and efficiently distributed across all applicable clients.

Vars
icon_height	The height of the icon to be used for each tile of the parallax layer, stored as to save processing time.
icon_width	The width of the icon to be used for each tile of the parallax layer, stored as to save processing time.
initial_x_coordinate	The x coordinate at which the parallax layer will be centred in the x-axis on the client's screen. Has no effect on layers set to tessellate.
initial_y_coordinate	The y coordinate at which the parallax layer will be centred in the y-axis on the client's screen. Has no effect on layers set to tessellate.
parallax_icon	The icon file that the icon for each tile of the parallax layer will draw from.
parallax_icon_state	The icon state that the icon for each tile of the parallax layer will use.
parallax_value	How much the parallax layer should move in response to the player moving;
scroll_angle	The compass bearing, in degrees, in which the parallax layer is to move. North: 0/360, East: 90, South: 180, West: 270.
scroll_speed	The non-parallax-adjusted speed at which the parallax layer should move. The real speed may be derived through `scroll_speed * parallax_value`.
static_colour	If set to TRUE, the parallax layer render source will retain its original colour when `/proc/recolour_parallax_render_sources()` is called.
tessellate	Whether the selected icon for the parallax layer should tessellate across the client's screen.
Procs
tessellate	If the parallax render source is set to tessellate, duplicates and offsets the selected icon for the parallax render source, so that the render source appears as a seamless image.

Var Details

var
icon_height
–

The height of the icon to be used for each tile of the parallax layer, stored as to save processing time.

var
icon_width
–

The width of the icon to be used for each tile of the parallax layer, stored as to save processing time.

var
initial_x_coordinate
–

The x coordinate at which the parallax layer will be centred in the x-axis on the client's screen. Has no effect on layers set to tessellate.

var
initial_y_coordinate
–

The y coordinate at which the parallax layer will be centred in the y-axis on the client's screen. Has no effect on layers set to tessellate.

var
parallax_icon
–

The icon file that the icon for each tile of the parallax layer will draw from.

var
parallax_icon_state
–

The icon state that the icon for each tile of the parallax layer will use.

var
parallax_value
–

How much the parallax layer should move in response to the player moving;

Negative values will result in the layer moving in the same direction as the player.
A value of 0 will result in the layer appearing stationary relative to the player.
A value of 0.5 will result in the layer moving half the number of pixels that the player moves.
A value of 1 will result in the layer appearing stationary relative to the station.
Values greater than 1 will result in the layer moving faster than the player.

var
scroll_angle
–

The compass bearing, in degrees, in which the parallax layer is to move. North: 0/360, East: 90, South: 180, West: 270.

var
scroll_speed
–

The non-parallax-adjusted speed at which the parallax layer should move. The real speed may be derived through scroll_speed * parallax_value.

var
static_colour
–

If set to TRUE, the parallax layer render source will retain its original colour when /proc/recolour_parallax_render_sources() is called.

var
tessellate
–

Whether the selected icon for the parallax layer should tessellate across the client's screen.

Proc Details

proc
tessellate
()

If the parallax render source is set to tessellate, duplicates and offsets the selected icon for the parallax render source, so that the render source appears as a seamless image.

/atom/movable/screen/parallax_render_source

Vars

Procs

Var Details

var icon_height –

var icon_width –

var initial_x_coordinate –

var initial_y_coordinate –

var parallax_icon –

var parallax_icon_state –

var parallax_value –

var scroll_angle –

var scroll_speed –

var static_colour –

var tessellate –