com.fs.starfarer.api.combat.ViewportAPI Interface Reference

Public Member Functions
boolean	isNearViewport (Vector2f loc, float nearDistance)
Vector2f	getCenter ()
float	getLLX ()
float	getLLY ()
float	getVisibleWidth ()
float	getVisibleHeight ()
float	getWorldXtoScreenX ()
float	getWorldYtoScreenY ()
float	getViewMult ()
float	getAlphaMult ()
float	convertScreenXToWorldX (float x)
float	convertScreenYToWorldY (float y)
float	convertWorldXtoScreenX (float x)
float	convertWorldYtoScreenY (float y)
float	convertWorldWidthToScreenWidth (float w)
float	convertWorldHeightToScreenHeight (float h)
float	convertScreenWidthToWorldWidth (float w)
float	convertScreenHeightToWorldHeight (float h)
void	set (float llx, float lly, float visibleWidth, float visibleHeight)
void	setViewMult (float zoom)
boolean	isExternalControl ()
void	setExternalControl (boolean externalControl)
void	setCenter (Vector2f c)
void	setAlphaMult (float alphaMult)

Detailed Description

Definition at line 5 of file ViewportAPI.java.

Member Function Documentation

convertScreenHeightToWorldHeight()

float com.fs.starfarer.api.combat.ViewportAPI.convertScreenHeightToWorldHeight

(

float

h

)

convertScreenWidthToWorldWidth()

float com.fs.starfarer.api.combat.ViewportAPI.convertScreenWidthToWorldWidth

(

float

w

)

convertScreenXToWorldX()

float com.fs.starfarer.api.combat.ViewportAPI.convertScreenXToWorldX

(

float

x

)

convertScreenYToWorldY()

float com.fs.starfarer.api.combat.ViewportAPI.convertScreenYToWorldY

(

float

y

)

convertWorldHeightToScreenHeight()

float com.fs.starfarer.api.combat.ViewportAPI.convertWorldHeightToScreenHeight

(

float

h

)

convertWorldWidthToScreenWidth()

float com.fs.starfarer.api.combat.ViewportAPI.convertWorldWidthToScreenWidth

(

float

w

)

convertWorldXtoScreenX()

float com.fs.starfarer.api.combat.ViewportAPI.convertWorldXtoScreenX

(

float

x

)

convertWorldYtoScreenY()

float com.fs.starfarer.api.combat.ViewportAPI.convertWorldYtoScreenY

(

float

y

)

getAlphaMult()

float com.fs.starfarer.api.combat.ViewportAPI.getAlphaMult

(

)

getCenter()

Vector2f com.fs.starfarer.api.combat.ViewportAPI.getCenter

(

)

getLLX()

float com.fs.starfarer.api.combat.ViewportAPI.getLLX

(

)

Returns

x coordinate of the lower left corner, in world units.

getLLY()

float com.fs.starfarer.api.combat.ViewportAPI.getLLY

(

)

Returns

y coordinate of the lower left corner, in world units.

getViewMult()

float com.fs.starfarer.api.combat.ViewportAPI.getViewMult

(

)

Returns

Current level zoom multiplier.

getVisibleHeight()

float com.fs.starfarer.api.combat.ViewportAPI.getVisibleHeight

(

)

Returns

Visible area's height, in world units.

getVisibleWidth()

float com.fs.starfarer.api.combat.ViewportAPI.getVisibleWidth

(

)

Returns

Visible area's width, in world units.

getWorldXtoScreenX()

float com.fs.starfarer.api.combat.ViewportAPI.getWorldXtoScreenX

(

)

getWorldYtoScreenY()

float com.fs.starfarer.api.combat.ViewportAPI.getWorldYtoScreenY

(

)

isExternalControl()

boolean com.fs.starfarer.api.combat.ViewportAPI.isExternalControl

(

)

isNearViewport()

boolean com.fs.starfarer.api.combat.ViewportAPI.isNearViewport	(	Vector2f	loc,
		float	nearDistance
	)

set()

void com.fs.starfarer.api.combat.ViewportAPI.set	(	float	llx,
		float	lly,
		float	visibleWidth,
		float	visibleHeight
	)

setAlphaMult()

void com.fs.starfarer.api.combat.ViewportAPI.setAlphaMult

(

float

alphaMult

)

setCenter()

void com.fs.starfarer.api.combat.ViewportAPI.setCenter

(

Vector2f

c

)

setExternalControl()

void com.fs.starfarer.api.combat.ViewportAPI.setExternalControl

(

boolean

externalControl

)

Tells the game not to set the viewport parameters every frame. Allows a mod to override viewport behavior.

Returns

setViewMult()

void com.fs.starfarer.api.combat.ViewportAPI.setViewMult

(

float

zoom

)

---

The documentation for this interface was generated from the following file:

• src/com/fs/starfarer/api/combat/ViewportAPI.java