Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

IpDrv.OnlineNewsInterfaceMcp

Extends
MCPBase
Modifiers
native implements ( OnlineNewsInterface )

Provides an in game news mechanism via the MCP backend 

Core.Object
|   
+-- IpDrv.MCPBase
   |   
   +-- IpDrv.OnlineNewsInterfaceMcp
Constants Summary
Inherited Contants from Core.Object
AspectRatio16x9, AspectRatio4x3, AspectRatio5x4, DegToRad, DegToUnrRot, INDEX_NONE, InvAspectRatio16x9, InvAspectRatio4x3, InvAspectRatio5x4, MaxInt, Pi, RadToDeg, RadToUnrRot, UnrRotToDeg, UnrRotToRad

Variables Summary
boolbNeedsTicking
array<NewsCacheEntry>NewsItems
array<delegate<OnReadNewsCompleted>>ReadNewsDelegates
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
Inherited Enumerations from Core.Object
AlphaBlendType, EAspectRatioAxisConstraint, EAutomatedRunResult, EAxis, EDebugBreakType, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
NewsCacheEntry
NewsUrl, ReadState, NewsType, NewsItem, TimeOut, bIsUnicode, HttpDownloader
Inherited Structures from Core.Object
Array_Mirror, BitArray_Mirror, BoneAtom, Box, BoxSphereBounds, Color, Cylinder, double, FColorVertexBuffer_Mirror, Guid, IndirectArray_Mirror, InlinePointerArray_Mirror, InterpCurveFloat, InterpCurveLinearColor, InterpCurvePointFloat, InterpCurvePointLinearColor, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, OctreeElementId, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, RenderCommandFence_Mirror, Rotator, Set_Mirror, SHVector, SHVectorRGB, SparseArray_Mirror, TAlphaBlend, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Delegates Summary
delegate OnReadNewsCompleted (bool bWasSuccessful, OnlineNewsType NewsType)

Functions Summary
function AddReadNewsCompletedDelegate (delegate<OnReadNewsCompleted> ReadNewsDelegate))
function ClearReadNewsCompletedDelegate (delegate<OnReadNewsCompleted> ReadGameNewsDelegate))
functionstring GetNews (byte LocalUserNum, OnlineNewsType NewsType))
functionbool ReadNews (byte LocalUserNum, OnlineNewsType NewsType)
Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, Atan2, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClampRotAxisFromBase, ClampRotAxisFromRange, ClassIsChildOf, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, DebugBreak, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, EvalInterpCurveFloat, EvalInterpCurveVector, EvalInterpCurveVector2D, Exp, FCeil, FClamp, FCubicInterp, FFloor, FindDeltaAngle, FindObject, FInterpConstantTo, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, float, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetBuildChangelistNumber, GetDotDistance, GetEngineVersion, GetEnum, GetFuncName, GetHeadingAngle, GetMappedRangeValue, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetRightMost, GetRotatorAxis, GetScriptTrace, GetStateName, GetSystemTime, GetUnAxes, GotoState, InCylinder, InStr, InverseTransformNormal, InverseTransformVector, IsA, IsChildState, IsInState, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, LerpColor, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, MakeRotationMatrix, MakeRotationTranslationMatrix, MakeRotator, MatrixGetAxis, MatrixGetOrigin, MatrixGetRotator, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, NoZDot, OrthoRotation, ParseLocalizedPropertyPath, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointDistToSegment, PointProjectToPlane, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, RTransform, SaveConfig, SClampRotAxis, ScriptTrace, SetUTracing, Sin, Split, SplitString, Sqrt, Square, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformNormal, TransformVector, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VRandCone, VRandCone2, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=

Variables Detail

bNeedsTicking Source code

var transient bool bNeedsTicking;
Whether there are outstanding requests that need ticking or not

NewsItems Source code

var config array<NewsCacheEntry> NewsItems;
The list of cached news items (ips, results, etc.)

ReadNewsDelegates Source code

var array<delegate<OnReadNewsCompleted>> ReadNewsDelegates;
The list of delegates to notify when the news read is complete

Structures Detail

NewsCacheEntry Source code

struct NewsCacheEntry
{
var const bool bIsUnicode;
var const native pointer HttpDownloader;
var string NewsItem;
var const EOnlineNewsType NewsType;
var const string NewsUrl;
var EOnlineEnumerationReadState ReadState;
var const float TimeOut;
};
Holds the IP, hostname, URL, and news results for a particular news type
bIsUnicode:
Whether the news item is in unicode or ansi
HttpDownloader:
Pointer to the native helper object that performs the download
NewsItem:
The results of the read
NewsType:
The type of news that we are reading
NewsUrl:
The URL to the news page that we're reading
ReadState:
The current async read state for the operation
TimeOut:
The amount of time before giving up on the read

Delegates Detail

OnReadNewsCompleted Source code

delegate OnReadNewsCompleted ( bool bWasSuccessful,EOnlineNewsType NewsType )
Delegate used in notifying the UI/game that the news read operation completed
@param bWasSuccessful true if the read completed ok, false otherwise
@param NewsType the type of news read that just completed

Functions Detail

AddReadNewsCompletedDelegate Source code

function AddReadNewsCompletedDelegate ( delegate<OnReadNewsCompleted> ReadNewsDelegate) )
Sets the delegate used to notify the gameplay code that news reading has completed
@param ReadGameNewsDelegate the delegate to use for notifications

ClearReadNewsCompletedDelegate Source code

function ClearReadNewsCompletedDelegate ( delegate<OnReadNewsCompleted> ReadGameNewsDelegate) )
Removes the specified delegate from the notification list
@param ReadGameNewsDelegate the delegate to use for notifications

GetNews Source code

function string GetNews ( byte LocalUserNum,EOnlineNewsType NewsType) )
Returns the game specific news item from the cache
@param LocalUserNum the local user the news is being read for
@param NewsType the type of news to read
@return an empty string if no data was read, otherwise the contents of the news read

ReadNews Source code

native function bool ReadNews ( byte LocalUserNum,EOnlineNewsType NewsType )
Reads the game specific news from the online subsystem
@param LocalUserNum the local user the news is being read for
@param NewsType the type of news to read
@return true if the async task was successfully started, false otherwise

Defaultproperties 

defaultproperties
{
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: ti 22-3-2011 19:56:53.482 - Created with UnCodeX