MIST getRandPointInCircle - Revision history

Grimes at 23:01, 3 June 2021

2021-06-03T23:01:47Z

Grimes at 22:57, 3 June 2021

2021-06-03T22:57:35Z

Acidictadpole: Acidictadpole moved page MIST getRandomPointInCircle to MIST getRandPointInCircle

2020-06-19T20:30:15Z

Acidictadpole moved page MIST getRandomPointInCircle to MIST getRandPointInCircle

Grimes at 22:59, 13 April 2018

2018-04-13T22:59:20Z

New page

{{Mission Scripting

|fName= mist.getRandPointInCircle|

|vNum = Mist 2.0

|desc= Returns a randomly generated vec2 coordinate within the specified radius around the center of vec 2 or vec3 point given. If the optional variable innerRadius is given the random point will be generated that has a minimum distance of innerRadius and a maximum distance of radius from the point.|

|rtnType= vec2

|reqType1= table

|reqName1= vec2/vec3

|reqType2= number

|reqName2= radius

|reqType3=

|reqName3=

|reqType4=

|reqName4=

|reqType5=

|reqName5=

|optType1= number

|optName1= innerRadius

|optType2=

|optName2=

|optType3=

|optName3=

|optType4=

|optName4=

|optType5=

|optName5=

|vars=

|varExamples= vec2/vec3 = valid vec2/3 table
radius = any positive number
innerRadius = any positive number less than radius

|rtnExamples= {{vec2}}

|example= The following code will deploy a smoke marker randomly inside a zone.

<code>
do
:local zone = trigger.misc.getZone('myZone')
:local newPoint = mist.getRandPointInCircle(zone.point, zone.radius)
:
end
</code>
|notes= Used within: [[groupToRandomZone]], [[groupRandomDistSelf]], [[groupToRandomPoint]]
|funcs= {{ListOfMistGeneralPurposeFuncs}}

}}
[[Category: MIST|getRandomPointInCircle]]

@@ Line 7: / Line 7: @@
 |desc= Returns a randomly generated vec2 coordinate within the specified radius around the center of vec 2 or vec3 point given. If the optional variable innerRadius is given the random point will be generated that has a minimum distance of innerRadius and a maximum distance of radius from the point.
-The optional values maxA and minA can be used to limit the possible area of a circle that the random point is returned within. Think of a pizza slice or Pacman as the shape that can be returned. '''maxA and minA are defined in degrees'''.
+The optional values maxA and minA can be used to limit the possible area of a circle that the random point is returned within. Think of a pizza slice or Pacman as the shape that can be returned. '''maxA and minA are defined in degrees'''. These values can be any number, however it is important to realize that they are used to generate a random point in a circle. maxA set to 540 for instance would simply result in a higher probability of the point returning in the right half of the circle compared to the left half.
 maxA is optional. If not present then it assumes the shape is a circle.
 minA is optional. If not present then the range will assume minA is 0 (North) to whatever maxA is set to if present.
@@ Line 59: / Line 60: @@
   radius = any positive number
   innerRadius = any positive number less than radius
 |rtnExamples= {{vec2}}

@@ Line 5: / Line 5: @@
 |vNum = Mist 2.0
-|desc= Returns a randomly generated vec2 coordinate within the specified radius around the center of vec 2 or vec3 point given. If the optional variable innerRadius is given the random point will be generated that has a minimum distance of innerRadius and a maximum distance of radius from the point.|
+|desc= Returns a randomly generated vec2 coordinate within the specified radius around the center of vec 2 or vec3 point given. If the optional variable innerRadius is given the random point will be generated that has a minimum distance of innerRadius and a maximum distance of radius from the point.
 |rtnType= vec2
@@ Line 33: / Line 38: @@
 |optName1= innerRadius
-|optType2=
+|optType2= number
-|optName2=
+|optName2= maxA
-|optType3=
+|optType3= number
-|optName3=
+|optName3= minA
 |optType4=
@@ Line 66: / Line 71: @@
 end
 </code>
 |notes= Used within: [[groupToRandomZone]], [[groupRandomDistSelf]], [[groupToRandomPoint]]
 |funcs= {{ListOfMistGeneralPurposeFuncs}}
 }}
 [[Category: MIST|getRandomPointInCircle]]

← Older revision	Revision as of 20:30, 19 June 2020
(No difference)