Differences

This shows you the differences between two versions of the page.

--- functions:a_getcvarfixed [2017/03/13 18:46] – created korshun
+++ functions:a_getcvarfixed [2017/06/16 13:25] (current) – korshun
@@ Line 1: / Line 1: @@
-#REDIRECT GetCVarFixed
+====== a_GetCVarFixed ======
+{{tag>zdoom cvar}}
+''fixed a_GetCVarFixed(str name)''
+<note important>This function is called ''a_GetCVarFixed()'' because it conflicts with [[:GDCC]]'s unrelated ''GetCVarFixed()''.</note>
+===== Description =====
+Returns the value of an int or float CVar as a fixed-point number.
+Returns 0 if the CVar doesn't exist or is not a number.
+The function works by calling [[zdoom>GetCVarString]] and parsing the text with [[atof]].
+===== Examples =====
+<code>
+int mul = a_GetCVarFixed("mymod_multiplier"); // declared as float in CVARINFO
+int value = FixedMul(x, mul);
+</code>
+From [[UpdateCursor]] source:
+<code>
+int sensitivity = a_GetCVarFixed("mouse_sensitivity");
+int speedX = FixedDiv(CursorSpeedX, FixedMul(a_GetCVarFixed("m_yaw"), sensitivity));
+int speedY = FixedDiv(CursorSpeedY, FixedMul(a_GetCVarFixed("m_pitch"), sensitivity));
+</code>
+===== See also =====
+  * [[GetUserCVarFixed]]

ACSUtils Wiki